Access v0.5.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 Access API describes the roles and permissions for access to Apiture APIs. This API defines two primary resources:

• A permission allows a user access to an API operation or set of operations, such as accessing an account, reading account transactions, scheduling transfers and payments, adding beneficiaries, or approving an application. All API operations that require OAuth2 authentication require specific permissions.
• A role represents an aggregation of permissions or other roles. Users may be assigned one or more roles, via the Users API and Operators API.

Each role has a name (a programmatic identifier), a short readable label, a longer description, a category, assignability (to users), and a list of child nodes and direct permissions. Fetching a role may also embed a full list of its effective permissions, which is the union of the set of the direct permissions in the role and the effective permissions of the direct child roles.

There are three categories of users, and thus three categories of roles that may be assigned to users.

1. Administrative users who manage the deployment (system).
2. Financial Institution operators, such as the deposits manager, the wire room staff, customer support, and so on. These financial institution users employ administrative and back office applications to manage the financial institution's digital banking. (operator)
3. Banking customers who hold accounts and use client applications to perform digital banking. (This is for future use). (customer)

Roles and permissions are organized in a directed acyclic graph. Roles are the nodes in the graph and permissions are the leaves. Roles may have child roles and child permissions, but permissions may not have children. The graph has a maximum nesting depth (node ancestry) of six roles. This version of the API is read-only. Future releases will define operations for creating and updating roles and permissions.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. See details at Secure Access.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. See details at Secure Access.
  • Flow: authorizationCode
  • Authorization URL = https://auth.apiture.com/oauth2/authorize
  • Token URL = https://auth.apiture.com/auth/oauth2/token

Permissions

Permissions for API Access

getMyAccess

Code samples

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

GET https://api.devbank.apiture.com/access/myAccess 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',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/access/myAccess',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/access/myAccess',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/myAccess");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return the current authenticated user's roles and permissions

GET https://api.devbank.apiture.com/access/myAccess

Return the current authenticated user's roles and permissions.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/access/userAccess/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "roles": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "categoryName": "customer",
      "label": "Create and Manage Transfers",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
        }
      }
    },
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "categoryName": "customer",
      "label": "Create and Manage Bill Payments",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
        }
      }
    }
  ],
  "effectiveRoles": [
    {
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "uri": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
    },
    {
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "uri": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
    }
  ],
  "effectivePermissions": [
    "getScheduledTransfer",
    "getScheduledTransfers",
    "createScheduledTransfer",
    "cancelScheduledTransfer",
    "updateScheduledTransfer",
    "deleteScheduledTransfer",
    "getPaymentInstruction",
    "getPaymentInstructions",
    "createPaymentInstruction",
    "submitPaymentInstruction",
    "cancelPaymentInstruction",
    "deletePaymentInstruction"
  ]
}

Responses

getPermissions

Code samples

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

GET https://api.devbank.apiture.com/access/permissions 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',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/access/permissions',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/access/permissions',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/permissions");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return a collection of API permissions

GET https://api.devbank.apiture.com/access/permissions

Return a paginated, collection of all API permissions. The links in the response include pagination links.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/access/permissions/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/access/permissions"
    }
  },
  "name": "permissions",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "name": "createScheduledTransfer",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
          }
        }
      },
      {
        "name": "updatedScheduledTransfer",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/updatedScheduledTransfer"
          }
        }
      }
    ]
  }
}

Responses

getPermission

Code samples

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

GET https://api.devbank.apiture.com/access/permissions/{permissionName} 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',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/access/permissions/{permissionName}',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/access/permissions/{permissionName}',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/access/permissions/{permissionName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/permissions/{permissionName}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch a representation of this permission

GET https://api.devbank.apiture.com/access/permissions/{permissionName}

Return a HAL representation of this permission resource.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
    },
    "apiture:roles": {
      "href": "https://api.devbank.apiture.com/access/roles?permission=createScheduledTransfer"
    }
  },
  "name": "createScheduledTransfer",
  "description": "Adds either a new one-time or a recurring transfer, to transfer funds between internal accounts or between an internal and a verified external account.",
  "label": "Create a new scheduled transfer request",
  "_embedded": {}
}

Responses

Roles

User Roles for API Access

getRoles

Code samples

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

GET https://api.devbank.apiture.com/access/roles 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',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/access/roles',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/access/roles',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/roles");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return a collection of roles

GET https://api.devbank.apiture.com/access/roles

Return a filterable collection of roles.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/access/roles/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/roles?start=00&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/access/roles"
    }
  },
  "name": "roles",
  "start": 0,
  "limit": 100,
  "count": 7,
  "_embedded": {
    "items": [
      {
        "name": "role1",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/99ade01a-e676-456c-a546-e2fd003c834b"
          }
        }
      },
      {
        "name": "role2",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/70cd5898-3e74-4fcf-917c-b14030a4a061"
          }
        }
      }
    ]
  }
}

Responses

getRole

Code samples

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

GET https://api.devbank.apiture.com/access/roles/{role} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/access/roles/{role}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/access/roles/{role}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/access/roles/{role}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/roles/{role}");
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"},
        "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/access/roles/{role}", data)
    req.Header = headers

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

Fetch a representation of this role

GET https://api.devbank.apiture.com/access/roles/{role}

Return a HAL representation of this role resource. Note that if looking up a role by name, the response will be a (301) redirect to the role resource by _id.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/access/role/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/roles/7655fcde-c3a4-404e-a662-9beede86bfa9"
    },
    "apiture:permissions": {
      "href": "https://api.devbank.apiture.com/access/permissions?role=7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  },
  "name": "moveMoney",
  "label": "Move Money",
  "description": "Create, modify, and cancel transfers, payments, checks, and other funds movement.",
  "categoryName": "customer",
  "assignable": true,
  "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9",
  "createdAt": "2021-01-25T12:46:06.375Z",
  "roles": [
    {
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "uri": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
    },
    {
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "uri": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
    }
  ],
  "permissions": [
    {
      "name": "getScheduledTransfer",
      "uri": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfer"
    },
    {
      "name": "getScheduledTransfers",
      "uri": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfers"
    }
  ],
  "_embedded": {
    "roles": [
      {
        "_profile": "https://production.api.apiture.com/schemas/access/role/v1.1.0/profile.json",
        "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
        "name": "transfers",
        "categoryName": "customer",
        "label": "Create and Manage Transfers",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
          }
        }
      },
      {
        "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
        "name": "payBills",
        "categoryName": "customer",
        "label": "Create and Manage Bill Payments",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
          }
        }
      }
    ],
    "permissions": [
      {
        "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
        "name": "getScheduledTransfer",
        "label": "View a scheduled transfer",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfer"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
        "name": "getScheduledTransfers",
        "label": "View all scheduled transfers",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfers"
          }
        }
      }
    ],
    "effectivePermissions": [
      "getScheduledTransfer",
      "getScheduledTransfers",
      "createScheduledTransfer",
      "cancelScheduledTransfer",
      "updateScheduledTransfer",
      "deleteScheduledTransfer",
      "getPaymentInstruction",
      "getPaymentInstructions",
      "createPaymentInstruction",
      "submitPaymentInstruction",
      "cancelPaymentInstruction",
      "deletePaymentInstruction"
    ]
  }
}

Responses

API

The Access API

getApi

Code samples

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

GET https://api.devbank.apiture.com/access/ 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/access/',
{
  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/access/',
  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/access/',
  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/access/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/");
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/access/", 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/access/

Return links to the top-level resources and operations in this API.

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/access/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/access/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/access/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/access/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/access/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/access/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/access/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/access/apiDoc", data)
    req.Header = headers

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

Return API definition document

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

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

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

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

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

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

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

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

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

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

permission

{
  "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
    },
    "apiture:roles": {
      "href": "https://api.devbank.apiture.com/access/roles?permission=createScheduledTransfer"
    }
  },
  "name": "createScheduledTransfer",
  "description": "Adds either a new one-time or a recurring transfer, to transfer funds between internal accounts or between an internal and a verified external account.",
  "label": "Create a new scheduled transfer request",
  "_embedded": {}
}

Permission (v1.0.0)

Representation of permission resources. A permission represents an allowed API operation. Permissions are aggregated into roles.

Links

Response and request bodies using this permission schema may contain the following links:

Properties

permissionReference

{
  "name": "approveApproval",
  "uri": "https://api.devbank.apiture.com/access/permissions/approveApproval"
}

Permission Reference (v1.0.0)

A reference to a permission resource.

Properties

permissions

{
  "_profile": "https://production.api.apiture.com/schemas/access/permissions/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/access/permissions?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/access/permissions"
    }
  },
  "name": "permissions",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "name": "createScheduledTransfer",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
          }
        }
      },
      {
        "name": "updatedScheduledTransfer",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/updatedScheduledTransfer"
          }
        }
      }
    ]
  }
}

Permission Collection (v1.0.0)

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

Properties

permissionsEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
        }
      },
      "name": "createScheduledTransfer",
      "description": "Create a new scheduled transfer in the `scheduledTransfers` collection.",
      "label": "Create a new scheduled transfer request"
    }
  ]
}

Permissions Embedded Objects (v1.0.0)

Objects embedded in the permissions schema.

Properties

role

{
  "_profile": "https://production.api.apiture.com/schemas/access/role/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/roles/7655fcde-c3a4-404e-a662-9beede86bfa9"
    },
    "apiture:permissions": {
      "href": "https://api.devbank.apiture.com/access/permissions?role=7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  },
  "name": "moveMoney",
  "label": "Move Money",
  "description": "Create, modify, and cancel transfers, payments, checks, and other funds movement.",
  "categoryName": "customer",
  "assignable": true,
  "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9",
  "createdAt": "2021-01-25T12:46:06.375Z",
  "roles": [
    {
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "uri": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
    },
    {
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "uri": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
    }
  ],
  "permissions": [
    {
      "name": "getScheduledTransfer",
      "uri": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfer"
    },
    {
      "name": "getScheduledTransfers",
      "uri": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfers"
    }
  ],
  "_embedded": {
    "roles": [
      {
        "_profile": "https://production.api.apiture.com/schemas/access/role/v1.1.0/profile.json",
        "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
        "name": "transfers",
        "categoryName": "customer",
        "label": "Create and Manage Transfers",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
          }
        }
      },
      {
        "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
        "name": "payBills",
        "categoryName": "customer",
        "label": "Create and Manage Bill Payments",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
          }
        }
      }
    ],
    "permissions": [
      {
        "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
        "name": "getScheduledTransfer",
        "label": "View a scheduled transfer",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfer"
          }
        }
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
        "name": "getScheduledTransfers",
        "label": "View all scheduled transfers",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfers"
          }
        }
      }
    ],
    "effectivePermissions": [
      "getScheduledTransfer",
      "getScheduledTransfers",
      "createScheduledTransfer",
      "cancelScheduledTransfer",
      "updateScheduledTransfer",
      "deleteScheduledTransfer",
      "getPaymentInstruction",
      "getPaymentInstructions",
      "createPaymentInstruction",
      "submitPaymentInstruction",
      "cancelPaymentInstruction",
      "deletePaymentInstruction"
    ]
  }
}

Role (v1.1.0)

Representation of role resources. A role is an aggregation of permissions or other roles. Users may be assigned one or more roles (although role assignment is outside the scope of this API.) Note that, while role's may be accessed by name or _id, the self link always uses the canonical form, _id.

Links

Response and request bodies using this role schema may contain the following links:

Properties

roleCategory

"system"

Role Category (v1.0.0)

The category of users that may be assigned this role.

roleCategory strings may have one of the following enumerated values:

type: string

enum values: system, operator, customer

roleEmbedded

{
  "roles": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "categoryName": "customer",
      "label": "Create and Manage Transfers",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
        }
      }
    },
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "categoryName": "customer",
      "label": "Create and Manage Bill Payments",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
        }
      }
    }
  ],
  "permissions": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
      "name": "getScheduledTransfer",
      "label": "View a scheduled transfer",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfer"
        }
      }
    },
    {
      "_profile": "https://production.api.apiture.com/schemas/access/permission/v1.0.0/profile.json",
      "name": "getScheduledTransfers",
      "label": "View all scheduled transfers",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/permissions/getScheduledTransfers"
        }
      }
    }
  ],
  "effectivePermissions": [
    "getScheduledTransfer",
    "getScheduledTransfers",
    "createScheduledTransfer",
    "cancelScheduledTransfer",
    "updateScheduledTransfer",
    "deleteScheduledTransfer",
    "getPaymentInstruction",
    "getPaymentInstructions",
    "createPaymentInstruction",
    "submitPaymentInstruction",
    "cancelPaymentInstruction",
    "deletePaymentInstruction"
  ]
}

Role Embedded Objects (v1.1.0)

Objects embedded in a role object.

Properties

roleReference

{
  "_id": "78c16684-0628-4363-a557-987839245d2c",
  "name": "approveApproval",
  "uri": "https://api.devbank.apiture.com/access/roles/78c16684-0628-4363-a557-987839245d2c"
}

Role Reference (v1.0.0)

A reference to a role resource.

Properties

roles

{
  "_profile": "https://production.api.apiture.com/schemas/access/roles/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/roles?start=00&limit=100"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/access/roles"
    }
  },
  "name": "roles",
  "start": 0,
  "limit": 100,
  "count": 7,
  "_embedded": {
    "items": [
      {
        "name": "role1",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/99ade01a-e676-456c-a546-e2fd003c834b"
          }
        }
      },
      {
        "name": "role2",
        "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/70cd5898-3e74-4fcf-917c-b14030a4a061"
          }
        }
      }
    ]
  }
}

Role Collection (v1.1.0)

Collection of roles. The items in the collection are listed in the _embedded.items array; the collection name is roles.

Properties

rolesEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/7655fcde-c3a4-404e-a662-9beede86bfa9"
        }
      },
      "name": "moveMoney",
      "label": "Move Money",
      "description": "Create, modify, and cancel transfers, payments, checks, and other funds movement.",
      "categoryName": "customer",
      "assignable": true,
      "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  ]
}

Roles Embedded Objects (v1.1.0)

Objects embedded in the roles collection.

Properties

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

summaryPermission

{
  "_profile": "https://production.api.apiture.com/schemas/access/summaryPermission/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/permissions/createScheduledTransfer"
    }
  },
  "name": "createScheduledTransfer",
  "description": "Create a new scheduled transfer in the `scheduledTransfers` collection.",
  "label": "Create a new scheduled transfer request"
}

Permission Summary (v1.0.0)

Summary representation of a permission resource in the permissions collection. A permission represents an allowed API operation. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get the full permission object.

Links

Response and request bodies using this summaryPermission schema may contain the following links:

Properties

summaryRole

{
  "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/access/roles/7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  },
  "name": "moveMoney",
  "label": "Move Money",
  "description": "Create, modify, and cancel transfers, payments, checks, and other funds movement.",
  "categoryName": "customer",
  "assignable": true,
  "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9"
}

Role Summary (v1.1.0)

Summary representation of a role resource in the roles collection. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get full role object.

Links

Response and request bodies using this summaryRole schema may contain the following links:

Properties

userAccess

{
  "_profile": "https://production.api.apiture.com/schemas/access/userAccess/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "roles": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "categoryName": "customer",
      "label": "Create and Manage Transfers",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
        }
      }
    },
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.1.0/profile.json",
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "categoryName": "customer",
      "label": "Create and Manage Bill Payments",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
        }
      }
    }
  ],
  "effectiveRoles": [
    {
      "_id": "0d3a9972-a843-458a-b6a9-dec3feb458ff",
      "name": "transfers",
      "uri": "https://api.devbank.apiture.com/access/roles/0d3a9972-a843-458a-b6a9-dec3feb458ff"
    },
    {
      "_id": "93959e3d-f61d-452f-8054-73a92cdfe263",
      "name": "payBills",
      "uri": "https://api.devbank.apiture.com/access/roles/93959e3d-f61d-452f-8054-73a92cdfe263"
    }
  ],
  "effectivePermissions": [
    "getScheduledTransfer",
    "getScheduledTransfers",
    "createScheduledTransfer",
    "cancelScheduledTransfer",
    "updateScheduledTransfer",
    "deleteScheduledTransfer",
    "getPaymentInstruction",
    "getPaymentInstructions",
    "createPaymentInstruction",
    "submitPaymentInstruction",
    "cancelPaymentInstruction",
    "deletePaymentInstruction"
  ]
}

User Access (v1.1.0)

The lists of the currently authenticated user's access: their assigned roles, any effective roles inherited from those assigned role's, and the full set of effective permissions associated with those roles.

Properties