Vault v0.15.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Vault API manages secure content files and document storage for other Apiture APIs and application use. Documents which may be stored in Vault include Terms and Conditions, privacy statements, check images, statements, images/documents required for an account application, etc. Clients may upload and download files with this API, or search for files by date or type or role. Files may be organized into hierarchical folders. Each file has a JSON representation file resource which includes the attributes (metadata) of the file (the name, type, size, _links, etc.), and a content resource which accesses the text or binary content of the file. The content URI is available via the apiture:content link in the file resource. The _links of a file or folder include an apiture:folder link to its containing folder. Each folder has apiture:files and apiture:children links to its directly contained files and subfolders, respectively.

To upload a file, first POST a request to the /uploads path (the createUpload operation) containing file resource(s) to be uploaded. When uploading a new file, the caller may specify a desired target folder by setting the apiture:folder link within the request's _links. The upload tracker response from the upload operation contains an array of items, one for each file to upload. Each item in the array contains an apiture:uploadUrl link, which is an upload URL for the corresponding file. The client should next PUT the file(s) content to the upload URLs to upload the files' contents. The upload is done when the upload resource state is completed or failed. The upload resource will contain the file resource resources in the items array within the _embedded object; each file will include a self link to the corresponding file resource.

After a file has been created, the file resource contains links to its containing folder, the public share URI, and the content URI for downloading the file's content.

For files which reside in folders with revisions enabled, updating a file's content creates a new revision of the file. The revisions are available from the file's /files/{fileId}/revisions collection.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/vault

Terms of service

Email: Apiture Web: Apiture

License: Pending.

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://auth.devbank.apiture.com/auth/oauth2/authorize
  • Token URL = https://api.devbank.apiture.com/auth/oauth2/token

Scope	Scope Description
data/read	Read access to non-account, non-profile data.
data/write	Write (update) access to non-account, non-profile data.
data/delete	Delete access to non-account, non-profile data.
data/full	Full access to non-account, non-profile data.

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/vault/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/vault/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/vault/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/vault/

Return links to the top-level resources and operations in this API. Links in the root response may include:

• apiture:files : A link to the collection of all files.
• apiture:folders : A link to the collection of all folders.
• apiture:uploads : A link to the collection of all upload tasks.
• apiture:myFolder : A link to the currently authenticated user's primary folder.
• apiture:myUploads : A link to the currently authenticated user's primary upload folder, a child folder of the user's primary folder.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/vault/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/vault/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/vault/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET https://api.devbank.apiture.com/vault/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Upload

Requests to upload new files into the file vault.

getUploads

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/uploads \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/uploads HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/uploads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/uploads',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/uploads',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/uploads', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/uploads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/uploads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of recent and in progress uploads

GET https://api.devbank.apiture.com/vault/uploads

Return a paginated sortable filterable searchable collection of uploads. The links in the response include pagination links. Upload resources expire after a while and these resources are automatically deleted.

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first upload in this page. The default, 0, represents the first page of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of upload representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
name in: query	string Subset the uploads collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell matches only items whose name is Bartell; ?name=Bartell|kirsten matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering.
filter in: query	string Optional filter criteria. See filtering.
q in: query	string Optional search string. See searching.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/uploads/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/uploads"
    },
    "apiture:myUploads": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 2,
  "name": "uploads",
  "_embedded": {
    "items": [
      {
        "_id": "d3a954aa-2027-4e92-b5b0-136bf31b1837",
        "count": 1,
        "name": "files",
        "_embedded": [
          {
            "name": "image1.png",
            "contentType": "image/png"
          },
          {
            "name": "image2.png",
            "contentType": "image/png"
          }
        ],
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/uploads/d3a954aa-2027-4e92-b5b0-136bf31b1837"
          }
        }
      },
      {
        "_id": "70ac012a-d66a-4a2a-8286-916dfda25799",
        "count": 1,
        "name": "files",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/uploads/70ac012a-d66a-4a2a-8286-916dfda25799"
          }
        }
      }
    ]
  }
}

Responses

createUpload

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/vault/uploads \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/vault/uploads HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/createUpload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/uploads',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/uploads',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/vault/uploads',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/vault/uploads', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/uploads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/vault/uploads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new upload

POST https://api.devbank.apiture.com/vault/uploads

Create a new file upload tracker. The caller provides a list of one or more files to be uploaded in _embedded.items.

This operation returns a modified upload tracker resource representation which contains embedded file resources. Each file resource contain the file name, type, etc. and a link named apiture:uploadUrl which points to an upload URL. The client must PUT the file content to those respective URLs to complete the uploads.

The state of the upload tracker shows the upload status. When the state is completes, the files associated with the upload will be in this resource's _embedded object with the name files; that value an array of file resource objects.

The target folder in which the file will be stored may be specified in _links using the apiture:folder link relation name.

If there is already a file of the same name in the target folder, the file is renamed by adding or incrementing a unique numeric suffix in parentheses. For example, if tax-summary-2018.pdf already exists, uploading a new document with that name will be renamed tax-summary-2018 (1).pdf; uploading another file will be renamed tax-summary-2018 (2).pdf, and so on.

TODO In the future, this API will also support uploading new revisions of the document and maintaining document revision history.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createUpload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg"
      }
    ]
  }
}

Parameters

Parameter	Description
body	createUpload (required) The data necessary to create a new upload.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/upload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "count": 2,
  "_embedded": {
    "items": [
      {
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      },
      {
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      }
    ]
  },
  "name": "files",
  "state": "pending",
  "expiresAt": "2017-12-23T00:00:00.000Z",
  "maximumFileSizeBytes": 25000000,
  "maximumReqestSizeBytes": 50000000
}

Responses

getUpload

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/uploads/{uploadId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/uploads/{uploadId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/uploads/{uploadId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/uploads/{uploadId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/uploads/{uploadId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/uploads/{uploadId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/uploads/{uploadId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/uploads/{uploadId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this upload

GET https://api.devbank.apiture.com/vault/uploads/{uploadId}

Return a HAL representation of this upload resource.

Parameters

Parameter	Description
uploadId in: path	string (required) The unique identifier of this upload. This is an opaque string.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/upload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "count": 2,
  "_embedded": {
    "items": [
      {
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      },
      {
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      }
    ]
  },
  "name": "files",
  "state": "pending",
  "expiresAt": "2017-12-23T00:00:00.000Z",
  "maximumFileSizeBytes": 25000000,
  "maximumReqestSizeBytes": 50000000
}

Responses

deleteUpload

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/vault/uploads/{uploadId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/vault/uploads/{uploadId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/uploads/{uploadId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/uploads/{uploadId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/vault/uploads/{uploadId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/vault/uploads/{uploadId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/uploads/{uploadId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/vault/uploads/{uploadId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this upload resource

DELETE https://api.devbank.apiture.com/vault/uploads/{uploadId}

Delete this upload resource and any resources that are owned by it. Note that deleting an upload does not delete any files that have been uploaded.

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
uploadId in: path	string (required) The unique identifier of this upload. This is an opaque string.

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

uploadContent

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/vault/uploads/{uploadId}/content \
  -H 'Content-Type: */*' \
  -H 'Accept: application/hal+json' \
  -H 'Content-Type: string' \
  -H 'API-Key: API_KEY'

POST https://api.devbank.apiture.com/vault/uploads/{uploadId}/content HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: */*
Accept: application/hal+json
Content-Type: string

const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/hal+json',
  'Content-Type':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/vault/uploads/{uploadId}/content',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'*/*',
  'Accept':'application/hal+json',
  'Content-Type':'string',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/uploads/{uploadId}/content',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/hal+json',
  'Content-Type' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.devbank.apiture.com/vault/uploads/{uploadId}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/hal+json',
  'Content-Type': 'string',
  'API-Key': 'API_KEY'
}

r = requests.post('https://api.devbank.apiture.com/vault/uploads/{uploadId}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/uploads/{uploadId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/hal+json"},
        "Content-Type": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/vault/uploads/{uploadId}/content", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Upload the file's raw content to the corresponding file resource.

POST https://api.devbank.apiture.com/vault/uploads/{uploadId}/content

Upload the raw content of the file as a stream of bytes. Examples include the binary bytes for an image or PDF document, or the multipart/form-data representation of the file. The Content-Type header (or the Content-Type in the multipart form data) must match the contentType of the file resource. The response is the /files/{fileId} file resource, not the file content. Note: This is a hidden operation which is a proxy for the apiture:uploadUrl link returned when creating a new upload in the createUpload operation. Clients should not assume this URL exists but should instead use the apiture:uploadUrl link that is returned when creating a new upload resource.

If the file is in a folder for which revisions are enable, this will create a new revision of the file; see the getFileRevisions and getFileRevision operations.

Body parameter

string

Parameters

Parameter	Description
uploadId in: path	string (required) The unique identifier of this upload. This is an opaque string.
Content-Type in: header	string (required) The media type describing the file's content type.
body	string(binary) (required) The file contents as a stream of bytes. format: binary

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/files/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/files?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/files"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

File

A file (document) in the file vault.

getFiles

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/files \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/files HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/files', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of files

GET https://api.devbank.apiture.com/vault/files

Return a paginated sortable filterable searchable collection of files. The links in the response include pagination links.

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first file in this page. The default, 0, represents the first page of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of file representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
name in: query	string Subset the files collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell matches only items whose name is Bartell; ?name=Bartell|kirsten matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering.
type in: query	string Subset the files collection to those with this exact type value. Use | to separate multiple values. For example, ?type=Personal%20Savings matches only items whose type is Personal Savings; ?type=Personal%20Savings|Investment%20Account matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See filtering.
filter in: query	string Optional filter criteria. See filtering.
q in: query	string Optional search string. See searching.
folder in: query	string Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/files/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/files?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/files"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

createFile

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/vault/files \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/vault/files HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFile/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/vault/files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/vault/files', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/vault/files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new file

POST https://api.devbank.apiture.com/vault/files

Create a new file in the files collection. This operation is called upon successful completion of an upload operation and associates the file resource (name, description, parent folder, etc.) with the file contents.

If there is already a file of the same name in the target folder, the file is renamed by adding a unique numeric suffix in parentheses. For example, if tax-summary-2018.pdf already exists, uploading a new document with that name will be renamed tax-summary-2018 (1).pdf.

The file will be placed in the folder specified in the apiture:folder link, which should be derived from the apiture:folder specified in upload request. If no folder was specified, the file is placed in the user's uploads folder.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFile/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture"
}

Parameters

Parameter	Description
body	createFile (required) The data necessary to create a new file.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

getFile

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/files/{fileId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/files/{fileId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the file resource

GET https://api.devbank.apiture.com/vault/files/{fileId}

Return a HAL representation of this file resource. The Content-Location response header, if present, identifies the equivalent revision.

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

updateFile

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/vault/files/{fileId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/vault/files/{fileId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this file resource

PUT https://api.devbank.apiture.com/vault/files/{fileId}

Perform a complete replacement of this file's descriptor.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body	file (required) A file resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

patchFile

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/vault/files/{fileId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/vault/files/{fileId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this file's descriptor

PATCH https://api.devbank.apiture.com/vault/files/{fileId}

Perform a partial update of this file's descriptor. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body	file (required) A file resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

deleteFile

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/vault/files/{fileId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/vault/files/{fileId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this file resource

DELETE https://api.devbank.apiture.com/vault/files/{fileId}

Delete this file resource and any resources that are owned by it.

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getFileRevisions

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}/revisions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}/revisions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/files/{fileId}/revisions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/files/{fileId}/revisions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}/revisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/files/{fileId}/revisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of file revisions

GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions

Return a paginated sortable filterable searchable collection of file revisions. The links in the response include pagination links.

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.
start in: query	integer(int64) The zero-based index of the first product revision item to include in this page. The default 0 denotes the beginning of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of product representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See sort criteria format, such as ?sortBy=field1,-field2.
filter in: query	string Optional filter criteria. See filtering.
q in: query	string Optional search string. See searching.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/files/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/files?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/files"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

getFileRevision

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of an immutable revision of this file

GET https://api.devbank.apiture.com/vault/files/{fileId}/revisions/{revisionId}

Return an immutable HAL representation of this revision of this file resource. The revision may also have prev and next links to previous and/or next revisions, if they exist.

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.
revisionId in: path	string (required) The identifier for a revision of this resource. Revision identifiers use ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

getFileContent

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/files/{fileId}/content \
  -H 'Accept: */*' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/files/{fileId}/content HTTP/1.1
Host: api.devbank.apiture.com
Accept: */*

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/files/{fileId}/content',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'*/*',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/files/{fileId}/content',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/files/{fileId}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/files/{fileId}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/files/{fileId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/files/{fileId}/content", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return the raw content of the file

GET https://api.devbank.apiture.com/vault/files/{fileId}/content

Return the raw content of the file as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available.

Parameters

Parameter	Description
fileId in: path	string (required) The unique identifier of this file. This is an opaque string.

Example responses

200 Response

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getSharedContent

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/content/{contentId} \
  -H 'Accept: */*'

GET https://api.devbank.apiture.com/vault/content/{contentId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: */*

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*'

};

fetch('https://api.devbank.apiture.com/vault/content/{contentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'*/*'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/content/{contentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/content/{contentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.devbank.apiture.com/vault/content/{contentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/content/{contentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/content/{contentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Get a shared file's content

GET https://api.devbank.apiture.com/vault/content/{contentId}

/content/{contentId} represents the shared URL Return the raw content of the file as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available.

In the future, a delete method will unshare a file.

Parameters

Parameter	Description
contentId in: path	string (required) The unique ID that refers to a file's raw content and represents the publicly shared file. This ID is not related to the {fileId} and can be revoked when the user decides to unshare a file.

Example responses

200 Response

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Folder

A container for files and other folders.

getFolders

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/folders \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/folders HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/folders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/folders', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/folders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of folders

GET https://api.devbank.apiture.com/vault/folders

Return a paginated sortable filterable searchable collection of folders. The links in the response include pagination links.

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first folder in this page. The default, 0, represents the first page of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of folder representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
name in: query	string Subset the folders collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell matches only items whose name is Bartell; ?name=Bartell|kirsten matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering.
filter in: query	string Optional filter criteria. See filtering.
q in: query	string Optional search string. See searching.
folder in: query	string Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folders/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/folders"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 17,
  "name": "folders",
  "_embedded": {
    "items": [
      {
        "name": "...",
        "description": "...",
        "_links": {
          "self": {
            "href": "..."
          }
        }
      }
    ]
  }
}

Responses

createFolder

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/vault/folders \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/vault/folders HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFolder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/vault/folders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/vault/folders', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/vault/folders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new folder

POST https://api.devbank.apiture.com/vault/folders

Create a new folder in the folders collection. To locate the folder within an existing folder (as a subfolder), specify the desired target folder with the apiture:folder link within the request body's _links.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFolder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any"
}

Parameters

Parameter	Description
body	createFolder (required) The data necessary to create a new folder.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Responses

getFolder

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/vault/folders/{folderId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/vault/folders/{folderId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders/{folderId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this folder

GET https://api.devbank.apiture.com/vault/folders/{folderId}

Return a HAL representation of this folder resource.

Parameters

Parameter	Description
folderId in: path	string (required) The unique identifier of this folder. This is an immutable opaque string.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Responses

updateFolder

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/vault/folders/{folderId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/vault/folders/{folderId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders/{folderId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this folder

PUT https://api.devbank.apiture.com/vault/folders/{folderId}

Perform a complete replacement of this folder.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Parameters

Parameter	Description
folderId in: path	string (required) The unique identifier of this folder. This is an immutable opaque string.
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body	folder (required) A folder contains files or other folders.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Responses

patchFolder

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/vault/folders/{folderId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/vault/folders/{folderId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders/{folderId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this folder

PATCH https://api.devbank.apiture.com/vault/folders/{folderId}

Perform a partial update of this folder. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Parameters

Parameter	Description
folderId in: path	string (required) The unique identifier of this folder. This is an immutable opaque string.
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body	folder (required) A folder contains files or other folders.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Responses

deleteFolder

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/vault/folders/{folderId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/vault/folders/{folderId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/vault/folders/{folderId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this folder resource

DELETE https://api.devbank.apiture.com/vault/folders/{folderId}

Delete this folder.

Normally, one can only delete a folder if it is empty (contains no files or subfolders). With the ?recursive=true option, this operation will delete a non-empty folder and its contents, including nested folders. The user must have authorization to delete all the contents.

The user may not delete their top-level folder.

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
folderId in: path	string (required) The unique identifier of this folder. This is an immutable opaque string.
recursive in: query	boolean If true, also delete all files and nested folders that are stored in this folder. default: false

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

Name	Description
Abstract Request (v2.0.0)	object An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource. This schema was resolved from common/abstractRequest.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

Name	Description
Abstract Resource (v2.1.0)	object An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links. This schema was resolved from common/abstractResource.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

attributes

{}

Attributes (v2.1.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

Name	Description
Attributes (v2.1.0)	object An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Collection (v2.1.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/collection.

Properties

Name	Description
Collection (v2.1.0)	object A collection of resources. This is an abstract model schema which is extended to define specific resource collections. This schema was resolved from common/collection.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

createFile

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFile/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture"
}

Create File

Representation used to create a new file. When creating a file, one can specify a link to the parent folder:

• apiture:folder A link to the desired target folder. The user must have permission to add files to this folder.

Properties

Name	Description
Create File	object Representation used to create a new file. When creating a file, one can specify a link to the parent folder: apiture:folder A link to the desired target folder. The user must have permission to add files to this folder.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string (required) The file name, for identification purposes. File names may include file extensions such as .pdf for PDF documents, although the system does not validate or ensure that extensions match the file content type. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this file and its contents. maxLength: 4096
type	string The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a processedCheckImage, mobileCheckDepositImageFront, etc.).
sizeBytes	integer The file size in bytes. When creating an upload, the caller can pass this in to indicate the file's size. The services uses this to generate a more accurate upload progress as a percentage of the total upload size. It is not enforced (that is, the actual upload size does not have to match this value).
contentType	string The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
revisionId	string The revision identifier for this file, if this file is in a folder that has revisions enabled. This is an ISO 8601 formatted date-time string, yyyy-mm-ddTHH:MM:SS.sssZ. This field is immutable. read-only
externalId	string If using external data hosting, externalId is used as a lookup key read-only
category	string (required) Required document category, within the enum of options. Required for compliance to categorize PII documents. enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, applicationFile, entityAuthorization, articlesOfOrganization, wireRequestForm, stateIdentificationFront, stateIdentificationBack

createFolder

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createFolder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any"
}

Create Folder

Representation used to create a new folder. When creating a new folder, the request may contain the following links:

• apiture:folder : The href is the URI of the desired parent folder. The user must have permission to add a subfolder to the parent folder.

Properties

Name	Description
Create Folder	object Representation used to create a new folder. When creating a new folder, the request may contain the following links: apiture:folder : The href is the URI of the desired parent folder. The user must have permission to add a subfolder to the parent folder.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string (required) The folder name, for identification purposes. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this folder and its contents. maxLength: 4096
type	string An optional folder type which describes the intended use or role of the folder and its contents.
revisionsEnabled	boolean If true, files in this folder maintain revisions. This property may not be changed after a folder has been created. Moving a file from a folder which has revisions enable to one that has them disabled will result in the loss of the revisions. default: false

createUpload

{
  "_profile": "https://production.api.apiture.com/schemas/vault/createUpload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg"
      }
    ]
  }
}

Create Upload

Representation used to create a new upload. The _embedded.items array must contain one or more file resources with the file name, description, type, and contentType. Optional links that are honored in an upload request include the following:

• apiture:folder : The target folder where to uploaded the file(s) should be placed.'

Properties

Name	Description
Create Upload	object Representation used to create a new upload. The _embedded.items array must contain one or more file resources with the file name, description, type, and contentType. Optional links that are honored in an upload request include the following: apiture:folder : The target folder where to uploaded the file(s) should be placed.'
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object (required) A list of the file descriptions which will be uploaded.
» items	array: [createFile] An array containing a summary of each file to be uploaded. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of files to upload. minimum: 1
name	string The name of the items collection in the items array in this upload's _embedded objects. This should be 'files'. maxLength: 32

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.1.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

Name	Description
Error (v2.1.0)	object Describes an error in an API request or in a service called via the API. This schema was resolved from common/error.
message	string (required) A localized message string describing the error condition.
_id	string A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string. read-only
statusCode	integer The HTTP status code associate with this error. minimum: 100 maximum: 599
type	string An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt	string(date-time) An RFC 3339 UTC time stamp indicating when the error occurred. format: date-time
attributes	attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type. Additional Properties: true
remediation	string An optional localized string which provides hints for how the user or client can resolve the error.
errors	array: [error] An optional array of nested error objects. This property is not always present. items: object

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.1.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

Name	Description
Error Response (v2.1.0)	object Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details. This schema was resolved from common/errorResponse.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

file

{
  "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "https://api.devbank.apiture.com/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture",
  "_embedded": {},
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

File

Representation of a file (document) resource residing in the file vault. A file may have the following links:

• apiture:folder : The folder where the file resides.
• apiture:share : The publicly shared URI of the file's content.
• apiture:content : The direct URI of the file's content
• apiture:uploadUrl : The URL which is used to upload the file content with PUT. This link only exists when this file representation is included within an upload tracker.
• apiture:revisions : The previous revisions of this file, if any.

Properties

Name	Description
File	object Representation of a file (document) resource residing in the file vault. A file may have the following links: apiture:folder : The folder where the file resides. apiture:share : The publicly shared URI of the file's content. apiture:content : The direct URI of the file's content apiture:uploadUrl : The URL which is used to upload the file content with PUT. This link only exists when this file representation is included within an upload tracker. apiture:revisions : The previous revisions of this file, if any.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The file name, for identification purposes. File names may include file extensions such as .pdf for PDF documents, although the system does not validate or ensure that extensions match the file content type. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this file and its contents. maxLength: 4096
type	string The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a processedCheckImage, mobileCheckDepositImageFront, etc.).
sizeBytes	number The file size in bytes. This is a derived property and cannot be modified in updates. read-only
contentType	string The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
revisionId	string The revision identifier for this file, if this file is in a folder that has revisions enabled. This is an ISO 8601 formatted date-time string, yyyy-mm-ddTHH:MM:SS.sssZ. This field is immutable. read-only
externalId	string If using external data hosting, externalId is used as a lookup key read-only
category	string Required document category, within the enum of options. Required for compliance to categorize PII documents. enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, applicationFile, entityAuthorization, articlesOfOrganization, wireRequestForm, stateIdentificationFront, stateIdentificationBack
effectiveStartAt	string(date-time) The date-time when this revision was created and became effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable. format: date-time
effectiveEndAt	string(date-time) The date-time when the another revision became effective and this revision ceased being effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable and is not present until the revision is no longer active. format: date-time
_id	string The unique identifier for this file resource. This is an immutable opaque string. read-only
createdAt	string(date-time) The date-time when the file was created or uploaded. read-only format: date-time

fileFields

{
  "name": "string",
  "description": "string",
  "type": "string",
  "sizeBytes": 0,
  "contentType": "application/pdf",
  "revisionId": "2018-08-22T11:34:14.375Z",
  "externalId": "bdca053e-399a-462b-bbb1-18c2682b1087",
  "category": "driversLicense"
}

File Fields

Core fields of the file resource. This model schema is used to construct other model schema.

Properties

Name	Description
File Fields	object Core fields of the file resource. This model schema is used to construct other model schema.
name	string The file name, for identification purposes. File names may include file extensions such as .pdf for PDF documents, although the system does not validate or ensure that extensions match the file content type. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this file and its contents. maxLength: 4096
type	string The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a processedCheckImage, mobileCheckDepositImageFront, etc.).
sizeBytes	integer The file size in bytes. When creating an upload, the caller can pass this in to indicate the file's size. The services uses this to generate a more accurate upload progress as a percentage of the total upload size. It is not enforced (that is, the actual upload size does not have to match this value).
contentType	string The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
revisionId	string The revision identifier for this file, if this file is in a folder that has revisions enabled. This is an ISO 8601 formatted date-time string, yyyy-mm-ddTHH:MM:SS.sssZ. This field is immutable. read-only
externalId	string If using external data hosting, externalId is used as a lookup key read-only
category	string Required document category, within the enum of options. Required for compliance to categorize PII documents. enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, applicationFile, entityAuthorization, articlesOfOrganization, wireRequestForm, stateIdentificationFront, stateIdentificationBack

files

{
  "_profile": "https://production.api.apiture.com/schemas/vault/files/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/files?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/files"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/vault/file/v1.3.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

File Collection

Collection of files. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
File Collection	object Collection of files. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object Embedded objects.
» items	array: [summaryFile] [Summary representation of a file resource in files collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.] items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

folder

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    },
    "apiture:files": {
      "href": "https://api.devbank.apiture.com/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    },
    "apiture:children": {
      "href": "https://api.devbank.apiture.com/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "createdAt": "2018-01-04T08:22:24.375Z"
}

Folder

Hierarchical folder structures for organizing related files and folders. A folder has a parent folder, a set of files, and a set of child folders. Links in a folder resource:

• apiture:folder : links to the parent folder, if the folder has a parent.
• apiture:files : links to the collection of files in the folder; this may be empty.
• apiture:children : links to the collection of subfolder whose parent is this folder; this may be empty.

Properties

Name	Description
Folder	object Hierarchical folder structures for organizing related files and folders. A folder has a parent folder, a set of files, and a set of child folders. Links in a folder resource: apiture:folder : links to the parent folder, if the folder has a parent. apiture:files : links to the collection of files in the folder; this may be empty. apiture:children : links to the collection of subfolder whose parent is this folder; this may be empty.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The folder name, for identification purposes. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this folder and its contents. maxLength: 4096
type	string An optional folder type which describes the intended use or role of the folder and its contents.
revisionsEnabled	boolean If true, files in this folder maintain revisions. This property may not be changed after a folder has been created. Moving a file from a folder which has revisions enable to one that has them disabled will result in the loss of the revisions. default: false
_id	string This folder's unique ID. read-only
fileCount	integer The number of files in this folder. read-only
folderCount	integer The number of subfolders of this folder read-only
createdAt	string(date-time) The date-time when the folder was created or uploaded. read-only format: date-time

folderFields

{
  "name": "My uploads",
  "description": "Default folder where new files are uploaded",
  "type": "any"
}

Folder Fields

Core fields of the folder resource. This model schema is used to construct other model schema.

Properties

Name	Description
Folder Fields	object Core fields of the folder resource. This model schema is used to construct other model schema.
name	string The folder name, for identification purposes. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this folder and its contents. maxLength: 4096
type	string An optional folder type which describes the intended use or role of the folder and its contents.
revisionsEnabled	boolean If true, files in this folder maintain revisions. This property may not be changed after a folder has been created. Moving a file from a folder which has revisions enable to one that has them disabled will result in the loss of the revisions. default: false

folders

{
  "_profile": "https://production.api.apiture.com/schemas/vault/folders/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=0&limit=100"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/folders?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/folders"
    }
  },
  "start": 0,
  "limit": 100,
  "count": 17,
  "name": "folders",
  "_embedded": {
    "items": [
      {
        "name": "...",
        "description": "...",
        "_links": {
          "self": {
            "href": "..."
          }
        }
      }
    ]
  }
}

Folder Collection

Collection of folders. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
Folder Collection	object Collection of folders. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object Embedded objects.
» items	array: [summaryFolder] An array containing a page of folder items. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

Properties

Name	Description
Link (v1.0.0)	object Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from common/link.
href	string(uri) (required) The URI or URI template for the resource/operation this link refers to. format: uri
type	string The media type for the resource.
templated	boolean If true, the link's href is a URI template.
title	string An optional human-readable localized title for the link.
deprecation	string(uri) If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation. format: uri
profile	string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. format: uri

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

Links (v1.0.0)

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

Properties

Name	Description
Links (v1.0.0)	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
Link (v1.0.0)	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from common/link.

revisionEffectiveInterval

{
  "effectiveStartAt": "2019-08-24T14:15:22Z",
  "effectiveEndAt": "2019-08-24T14:15:22Z"
}

Revision Effective Time Interval (v1.0.0)

Time interval when a resource revision was effective and in use. This schema is used when composing other schemas.

Properties

Name	Description
Revision Effective Time Interval (v1.0.0)	object Time interval when a resource revision was effective and in use. This schema is used when composing other schemas.
effectiveStartAt	string(date-time) The date-time when this revision was created and became effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable. format: date-time
effectiveEndAt	string(date-time) The date-time when the another revision became effective and this revision ceased being effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable and is not present until the revision is no longer active. format: date-time

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.0)

A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

Properties

Name	Description
API Root (v2.1.0)	object A HAL response, with hypermedia _links for the top-level resources and operations in API. This schema was resolved from common/root.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string This API's unique ID. read-only
name	string This API's name.
apiVersion	string This API's version.

summaryFile

{
  "_profile": "https://production.api.apiture.com/schemas/vault/summaryFile/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/files/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "avatar.png",
  "description": "My personal avatar",
  "contentType": "image/png",
  "type": "profilePicture"
}

File Summary

Summary representation of a file resource in files collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

Name	Description
File Summary	object Summary representation of a file resource in files collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The file name, for identification purposes. File names may include file extensions such as .pdf for PDF documents, although the system does not validate or ensure that extensions match the file content type. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this file and its contents. maxLength: 4096
type	string The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a processedCheckImage, mobileCheckDepositImageFront, etc.).
sizeBytes	integer The file size in bytes. When creating an upload, the caller can pass this in to indicate the file's size. The services uses this to generate a more accurate upload progress as a percentage of the total upload size. It is not enforced (that is, the actual upload size does not have to match this value).
contentType	string The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
revisionId	string The revision identifier for this file, if this file is in a folder that has revisions enabled. This is an ISO 8601 formatted date-time string, yyyy-mm-ddTHH:MM:SS.sssZ. This field is immutable. read-only
externalId	string If using external data hosting, externalId is used as a lookup key read-only
category	string Required document category, within the enum of options. Required for compliance to categorize PII documents. enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, applicationFile, entityAuthorization, articlesOfOrganization, wireRequestForm, stateIdentificationFront, stateIdentificationBack
effectiveStartAt	string(date-time) The date-time when this revision was created and became effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable. format: date-time
effectiveEndAt	string(date-time) The date-time when the another revision became effective and this revision ceased being effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ. This field is derived and immutable and is not present until the revision is no longer active. format: date-time
_id	string The unique identifier for this file resource. This is an immutable opaque string. read-only

summaryFolder

{
  "_profile": "https://production.api.apiture.com/schemas/vault/summaryFolder/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "name": "My upload'https://api.devbank.apiture.coms'",
  "description": "Default folder where new files are uploaded.",
  "type": "any",
  "_id": "0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
}

Folder Summary

Summary representation of a folder resource in folders collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

Name	Description
Folder Summary	object Summary representation of a folder resource in folders collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The folder name, for identification purposes. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this folder and its contents. maxLength: 4096
type	string An optional folder type which describes the intended use or role of the folder and its contents.
revisionsEnabled	boolean If true, files in this folder maintain revisions. This property may not be changed after a folder has been created. Moving a file from a folder which has revisions enable to one that has them disabled will result in the loss of the revisions. default: false
_id	string The unique identifier for this folder resource. This is an immutable opaque string. read-only

summaryUpload

{
  "_profile": "https://production.api.apiture.com/schemas/vault/summaryUpload/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "count": 2,
  "_embedded": {}
}

Upload Summary

Summary representation of an upload tracker resource in the uploads collection. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

Name	Description
Upload Summary	object Summary representation of an upload tracker resource in the uploads collection. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of files to upload. minimum: 1
name	string The name of the items collection in the items array in this upload's _embedded objects. This should be 'files'. maxLength: 32
_id	string The unique identifier for this upload resource. This is an immutable opaque string. read-only

upload

{
  "_profile": "https://production.api.apiture.com/schemas/vault/upload/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "count": 2,
  "_embedded": {
    "items": [
      {
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      },
      {
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "https://api.devbank.apiture.com/some/opaque/upload/url/for/this/file"
          }
        }
      }
    ]
  },
  "name": "files",
  "state": "pending",
  "expiresAt": "2017-12-23T00:00:00.000Z",
  "maximumFileSizeBytes": 25000000,
  "maximumReqestSizeBytes": 50000000
}

Upload

A request to start a file upload. Optional links that are honored in an upload request include the following:

• apiture:folder : The target folder for where to upload the file(s)

This upload tracker response contains an array of items, one for each file to upload. Each item contains an apiture:uploadUrl link within the item's _links. The client should next PUT the file(s) content to the upload URLs to upload each file's contents.

Properties

Name	Description
Upload	object A request to start a file upload. Optional links that are honored in an upload request include the following: apiture:folder : The target folder for where to upload the file(s) This upload tracker response contains an array of items, one for each file to upload. Each item contains an apiture:uploadUrl link within the item's _links. The client should next PUT the file(s) content to the upload URLs to upload each file's contents.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object A list of the file descriptions which will be uploaded.
» items	array: [summaryFile] An array containing a summary of each file to be uploaded. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of files to upload. minimum: 1
name	string The name of the items collection. In this case, the items in the embedded list are 'files'. enum values: files
_id	string The unique identifier for this upload resource. This is an immutable opaque string. read-only
state	string The status of the upload request. pending - The upload is pending but has not started started - The upload has started completed - The upload has completed successfully failed - The upload has failed or timed out. enum values: pending, started, completed, failed
maximumFileSizeBytes	integer The maximum individual file size allowed, in bytes. This is a derived field and ignored in an upload request. read-only
maximumRequestSizeBytes	integer The maximum upload request size allowed, in bytes; this is the total size of the multipart/form-data request which is larger than the sum of just the file bytes due to extra metadata and encoding in a multipart/form-data request body. This is a derived field and ignored in an upload request. read-only
expiresAt	string(date-time) The date-time when this upload request expires. If no file is uploaded by this time, this upload request will be deleted and the upload URL in each file resource may no longer work. This is a derived field and ignored in an upload request. read-only format: date-time

uploadFields

{
  "count": 1,
  "name": "string"
}

Upload Fields

Core fields of the upload resource. This model schema is used to construct other model schema.

Properties

Name	Description
Upload Fields	object Core fields of the upload resource. This model schema is used to construct other model schema.
count	integer The number of files to upload. minimum: 1
name	string The name of the items collection in the items array in this upload's _embedded objects. This should be 'files'. maxLength: 32

uploads

{
  "_profile": "https://production.api.apiture.com/schemas/vault/uploads/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/vault/uploads?start=100&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/vault/uploads"
    },
    "apiture:myUploads": {
      "href": "https://api.devbank.apiture.com/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 2,
  "name": "uploads",
  "_embedded": {
    "items": [
      {
        "_id": "d3a954aa-2027-4e92-b5b0-136bf31b1837",
        "count": 1,
        "name": "files",
        "_embedded": [
          {
            "name": "image1.png",
            "contentType": "image/png"
          },
          {
            "name": "image2.png",
            "contentType": "image/png"
          }
        ],
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/uploads/d3a954aa-2027-4e92-b5b0-136bf31b1837"
          }
        }
      },
      {
        "_id": "70ac012a-d66a-4a2a-8286-916dfda25799",
        "count": 1,
        "name": "files",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/vault/uploads/70ac012a-d66a-4a2a-8286-916dfda25799"
          }
        }
      }
    ]
  }
}

Upload Collection

Collection of uploads. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
Upload Collection	object Collection of uploads. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object Embedded objects.
» items	array: [summaryUpload] An array containing a page of upload items. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

---