Operators v0.11.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 Opgeterators API manages operators at the financial institution: administrators and other administrative application users, such as the deposits manager, the wire room operators, customer support representatives, and so on. These operators use administrative and back office applications to manage the financial institution's digital banking offering and to support their customers. This API supports:

• Creating new operators
• Update operator information
• Listing and searching for operators
• Add roles to an operator
• Remove roles from an operator
• Service configuration

Each operator may be assigned roles which grant the operator a set of permissions within the various Apiture Open Digital Banking and Administrative applications. The permissions represent allowed API operations in the Apiture Open Banking APIs. Roles and permissions are managed by the Access API. Some financial institutions configure their operator identity management via federated identity. In these cases, this API is limited. This API may not create new operators (the financial institution creates and manages operators directly in their identity management platform) nor may this API update the operator's personal details via updateOperator or patchOperator. This API is used only by administrative applications; the application users are operators or system administrators who have permissions to view, create and modify other operator users.

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

cannotChangeOwnRoles

Description: An operator may not change their own role.
Remediation: Only another operator may change the current user's role.

createOperatorDisabled

Description: The createOperator role is disabled.
Remediation: The financial institution must add operators directly via their identity provider.

groupNotFound

Description: No Groups were found for the specified groupName.
Remediation: Check to make sure that the supplied groupName corresponds to an apiture group resource.

invalidEmailDomain

Description: The email address in the request has a domain that is not allowed.
Remediation: Use an email address with a domain that satisfies the financial institution's restrictions.

invalidRole

Description: The role in the request is missing the role _id or it refers to role that does not exist or is not assignable.
Remediation: Use a request that includes the _id of an existing, assignable role.

invalidRoleCategory

Description: Cannot assign a role with the category system to an operator.
Remediation: Assign only roles in the operator or customer categories.

invalidRoleRank

Description: Cannot assign a role with a rank that is higher than the operator's roleRank.
Remediation: Choose a role whose rank is not greater than the operator's roleRank.

noSuchOperator

Description: No such operator at the given {operatorId}.
Remediation: Use the operator's self link when updating an operator.

noSuchOperatorRole

Description: No such role {roleId} in the given operator's roles .
Remediation: Use the the {roleId of a role assigned to the operator.

noSuchRoleReference

Description: The requested role does not exist.
Remediation: Use a _id of an existing, assignable role.

operatorAlreadyExists

Description: An operator already exists for the given email address.
Remediation: Use the existing operator, or create the operator with a unique email address.

tooManyOperatorRoles

Description: Cannot add another role to the operator.
Remediation: Remove some roles first, or assign a role that aggregates the roles you want to assign the operator.

valueNotFound

Description: No Group values were found for the specified groupName and valueName.
Remediation: Check to make sure that the supplied groupName and valueName corresponds to an apiture group and value resource.

Download OpenAPI Definition (YAML)

Base URLs:

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

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

Scope	Scope Description
access/read	Read access to system configuration.
access/write	Write (update) access to system configuration.
access/delete	Delete access to system configuration.
access/full	Full access to system configuration.

Operators

Financial Institution Operators

getOperators

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return a collection of operators

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

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

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first operator 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 operator 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. This collection may be sorted by the following properties: • createdAt • updatedAt • emailAddress • firstName • lastName • state • username.
emailAddress in: query	string(email) Filter the collection of operators by the given email address (case insensitive). format: email
username in: query	string Filter the collection of operators by the username (case insensitive).
lastName in: query	string Filter the collection of operators by the last name (case insensitive).
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions: • Property emailAddress using functions eq, startsWith, contains • Property username using functions eq, startsWith, contains • Property firstName using functions eq, startsWith, contains • Property lastName using functions eq, startsWith, contains.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operators/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/operators/operators"
    }
  },
  "name": "operators",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/operators/summaryOperator/v1.4.1/profile.json",
        "firstName": "Casey",
        "middleInitial": "K",
        "lastName": "Hargrove",
        "emailAddress": "Casey.Hargrove@3rdparty.bank",
        "mobilePhoneNumber": "+19105550155",
        "username": "casey.hargrove@3rdparty.bank",
        "identityType": "operator",
        "federated": false,
        "jobTitle": "Wire Room Operator",
        "category": "operator",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d8df5f3b-c049-4418-a8d1-bc45d0c1f067",
        "_profile": "https://production.api.apiture.com/schemas/operators/summaryOperator/v1.4.1/profile.json",
        "firstName": "Thomas",
        "middleInitial": "M",
        "lastName": "Williams",
        "emailAddress": "Thomas.Williams@3rdparty.bank",
        "mobilePhoneNumber": "+19105555155",
        "username": "thomas.williams@3rdparty.bank",
        "identityType": "operator",
        "federated": false,
        "jobTitle": "Customer Success Manager",
        "category": "operator",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/operators/operators/d8df5f3b-c049-4418-a8d1-bc45d0c1f067"
          }
        }
      }
    ]
  }
}

Responses

createOperator

Code samples

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

POST https://api.devbank.apiture.com/operators/operators HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/operators/createOperator/v1.1.1/profile.json",
  "_links": {},
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "mobilePhoneNumber": "+19105550155",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/operators");
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/json"},
        "Accept": []string{"application/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/operators/operators", data)
    req.Header = headers

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

Create a new operator

POST https://api.devbank.apiture.com/operators/operators

Create a new operator.

Note: This operation is only valid if the service configuration GET /operators/configurations/groups/features/values/createOperatorEnabled returns true.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/operators/createOperator/v1.1.1/profile.json",
  "_links": {},
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "mobilePhoneNumber": "+19105550155",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator"
    }
  ]
}

Parameters

Parameter	Description
body	createOperator The data necessary to create a new operator.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

getOperator

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/operators/operators/{operatorId} \
  -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/operators/operators/{operatorId} 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/operators/operators/{operatorId}',
{
  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/operators/operators/{operatorId}',
  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/operators/operators/{operatorId}',
  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/operators/operators/{operatorId}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of this operator

GET https://api.devbank.apiture.com/operators/operators/{operatorId}

Return a HAL representation of this operator resource.

Parameters

Parameter	Description
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 returns 304 (Not Modified) and no response body, else the resource representation is returned.
embed in: query	array[string] A pipe-delimited list of properties to include in the returned operator's _embedded objects. List items must be (assignedRoles, allRoles, permissions property names of the operatorEmbedded model schema. pipe-delimited items: string » enum values: assignedRoles, allRoles, permissions
operatorId in: path	string (required) The unique identifier of this operator. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

patchOperator

Code samples

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

PATCH https://api.devbank.apiture.com/operators/operators/{operatorId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/operators/{operatorId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.devbank.apiture.com/operators/operators/{operatorId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.devbank.apiture.com/operators/operators/{operatorId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/operators/{operatorId}");
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/json"},
        "Accept": []string{"application/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/operators/operators/{operatorId}", data)
    req.Header = headers

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

Patch this operator

PATCH https://api.devbank.apiture.com/operators/operators/{operatorId}

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

Note: This operation is only valid if the service configuration GET /operators/configurations/groups/features/values/updateOperatorEnabled returns true.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

updateOperator

Code samples

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

PUT https://api.devbank.apiture.com/operators/operators/{operatorId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/operators/{operatorId}',
  method: 'put',

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/operators/operators/{operatorId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/operators/operators/{operatorId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/operators/{operatorId}");
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/json"},
        "Accept": []string{"application/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/operators/operators/{operatorId}", data)
    req.Header = headers

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

Update this operator

PUT https://api.devbank.apiture.com/operators/operators/{operatorId}

Perform a complete replacement of this operator.

Note: This operation is only valid if the service configuration GET /operators/configurations/groups/features/values/updateOperatorEnabled returns true.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

getMyProfile

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/operators/myProfile \
  -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/operators/myProfile 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/operators/myProfile',
{
  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/operators/myProfile',
  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/operators/myProfile',
  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/operators/myProfile', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of the current operator

GET https://api.devbank.apiture.com/operators/myProfile

Return a HAL representation of the operator resource for the current authenticated user. If executed from a federated user who does not have a corresponding operator resource, the result may be partial. For example, it may imit the operator _id and state or other properties.

Note: This operation may redirect (HTTP response 302) to the correct getOperator call and the Location header will contain the correct {operatorId} path parameter.

Parameters

Parameter	Description
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 returns 304 (Not Modified) and no response body, else the resource representation is returned.
embed in: query	array[string] A pipe-delimited list of properties to include in the returned operator's _embedded objects. List items must be (assignedRoles, allRoles, permissions property names of the operatorEmbedded model schema. pipe-delimited items: string » enum values: assignedRoles, allRoles, permissions

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

Operator Actions

Actions on Operators

deactivateOperator

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/operators/inactiveOperators?operator=string \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/operators/inactiveOperators?operator=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
If-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/operators/inactiveOperators?operator=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/inactiveOperators',
  method: 'post',
  data: '?operator=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/operators/inactiveOperators',
  params: {
  'operator' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/operators/inactiveOperators', params={
  'operator': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/inactiveOperators?operator=string");
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{
        "Accept": []string{"application/json"},
        "If-Match": []string{"string"},
        "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/operators/inactiveOperators", data)
    req.Header = headers

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

Deactivate an operator

POST https://api.devbank.apiture.com/operators/inactiveOperators

Deactivate an operator. This changes the state property of the operator to inactive. This operation is allowed if and only if the caller has permissions to change another operator's state. If allowed, this operation is available via the apiture:deactivate link on the operator resource. The response is the updated representation of the operator. The If-Match request header value, if passed, must match the current entity tag value of the operator.

This operation is idempotent; it makes no changes if the operator state is inactive.

Parameters

Parameter	Description
operator in: query	string (required) A string which uniquely identifies the operator to deactivate. This may be the unique operator._id or the URI of the operator.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

activateOperator

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/operators/activeOperators?operator=string \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/operators/activeOperators?operator=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
If-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/operators/activeOperators?operator=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/activeOperators',
  method: 'post',
  data: '?operator=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/operators/activeOperators',
  params: {
  'operator' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/operators/activeOperators', params={
  'operator': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/activeOperators?operator=string");
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{
        "Accept": []string{"application/json"},
        "If-Match": []string{"string"},
        "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/operators/activeOperators", data)
    req.Header = headers

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

Activate an operator

POST https://api.devbank.apiture.com/operators/activeOperators

Activate an operator. This changes the state property of the operator to active. This operation is allowed if and only if the caller has permissions to change another operator's state. If allowed, this operation is available via the apiture:activate link on the operator resource. The response is the updated representation of the operator. The If-Match request header value, if passed, must match the current entity tag value of the operator.

This operation is idempotent; it makes no changes if the operator state is active.

Parameters

Parameter	Description
operator in: query	string (required) A string which uniquely identifies the operator to activate. This may be the unique operator._id or the URI of the operator.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Responses

Roles

Financial Institution Operators

getOperatorRoles

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return a collection of roles assigned to an operator

GET https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments

Return a list of roles assigned to an operator.

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first role 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 role 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.
filter in: query	string Optional filter criteria. See filtering.
operatorId in: path	string (required) The unique identifier of this operator. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operatorRoleAssignments/v1.1.1/profile.json",
  "_links": {},
  "items": [
    {
      "_id": "d01a2bbc-b67f-438d-82b4-6d2a2f0060dc",
      "name": "customerSuccessManager"
    },
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator"
    }
  ]
}

Responses

addOperatorRole

Code samples

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

POST https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "78c16684-0628-4363-a557-987839245d2c",
  "name": "approveApproval",
  "uri": "https://api.devbank.apiture.com/access/roles/78c16684-0628-4363-a557-987839245d2c"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments");
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/json"},
        "Accept": []string{"application/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/operators/operators/{operatorId}/roleAssignments", data)
    req.Header = headers

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

Assign a role to an operator

POST https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments

Add a role to operator's list of role assignments. This operation is idempotent; if the operator already has the role, no changes are made.

Body parameter

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

Parameters

Parameter	Description
body	roleReference A role to add to an operator's list of roles.
operatorId in: path	string (required) The unique identifier of this operator. This is an opaque string.

Example responses

200 Response

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

Responses

getOperatorRole

Code samples

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

GET https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId} 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/operators/operators/{operatorId}/roleAssignments/{roleId}',
{
  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/operators/operators/{operatorId}/roleAssignments/{roleId}',
  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/operators/operators/{operatorId}/roleAssignments/{roleId}',
  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/operators/operators/{operatorId}/roleAssignments/{roleId}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of one of this operator's roles

GET https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId}

Return a HAL representation of one of this operator's role assignments.

Parameters

Parameter	Description
operatorId in: path	string (required) The unique identifier of this operator. This is an opaque string.
roleId in: path	string (required) The unique _id (identifier) of a role.

Example responses

200 Response

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

Responses

deleteOperatorRole

Code samples

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

DELETE https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId} 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/operators/operators/{operatorId}/roleAssignments/{roleId}',
{
  method: 'DELETE',

  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/operators/operators/{operatorId}/roleAssignments/{roleId}',
  method: 'delete',

  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.delete 'https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId}");
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/json"},
        "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/operators/operators/{operatorId}/roleAssignments/{roleId}", data)
    req.Header = headers

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

Remove an operator role

DELETE https://api.devbank.apiture.com/operators/operators/{operatorId}/roleAssignments/{roleId}

Delete a role from the operator's list of assigned roles.

Parameters

Parameter	Description
operatorId in: path	string (required) The unique identifier of this operator. This is an opaque string.
roleId in: path	string (required) The unique _id (identifier) of a role.

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/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

API

The Financial Institution Operators API

getApi

Code samples

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

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

}, headers = headers)

print r.json()

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

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

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

}, headers = headers)

print r.json()

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

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

Return API definition document

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

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

getLabels

Code samples

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

GET https://api.devbank.apiture.com/operators/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
Accept-Language: string

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/labels");
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"},
        "Accept-Language": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Localized Labels

GET https://api.devbank.apiture.com/operators/labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (en-us).

Parameters

Parameter	Description
Accept-Language in: header	string The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

Configuration

Service Configuration

getConfigurationGroups

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return a collection of configuration groups

GET https://api.devbank.apiture.com/operators/configurations/groups

Return a paginated sortable filterable collection of configuration groups. The links in the response include pagination links.

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first configuration group 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 configuration group 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.
filter in: query	string Optional filter criteria. See filtering.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Responses

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName} \
  -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/operators/configurations/groups/{groupName} 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/operators/configurations/groups/{groupName}',
{
  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/operators/configurations/groups/{groupName}',
  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/operators/configurations/groups/{groupName}',
  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/operators/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of this configuration group

GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
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 returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Responses

getConfigurationGroupSchema

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/schema \
  -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/operators/configurations/groups/{groupName}/schema 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/operators/configurations/groups/{groupName}/schema',
{
  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/operators/configurations/groups/{groupName}/schema',
  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/operators/configurations/groups/{groupName}/schema',
  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/operators/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/schema");
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/operators/configurations/groups/{groupName}/schema", data)
    req.Header = headers

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

Fetch the schema for this configuration group

GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
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 returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values \
  -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/operators/configurations/groups/{groupName}/values 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/operators/configurations/groups/{groupName}/values',
{
  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/operators/configurations/groups/{groupName}/values',
  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/operators/configurations/groups/{groupName}/values',
  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/operators/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values");
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/operators/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Fetch the values for the specified configuration group

GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
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 returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Responses

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": 63000
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values',
  method: 'put',

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values");
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/json"},
        "Accept": []string{"application/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/operators/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	configurationValues JSON values to replace all items in this configuration group.

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Responses

getConfigurationGroupValue

Code samples

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

GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName} 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/operators/configurations/groups/{groupName}/values/{valueName}',
{
  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/operators/configurations/groups/{groupName}/values/{valueName}',
  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/operators/configurations/groups/{groupName}/values/{valueName}',
  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/operators/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}");
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/operators/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

GET https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To update a specific value, use PUT /operators/configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
valueName in: path	string (required) The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*.

Example responses

200 Response

"string"

Responses

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}',
  method: 'put',

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}");
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/json"},
        "Accept": []string{"application/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/operators/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT https://api.devbank.apiture.com/operators/configurations/groups/{groupName}/values/{valueName}

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To fetch specific value, use GET /operators/configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
valueName in: path	string (required) The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
value in: query	string The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.
body	string JSON value to assign to the configuration item.

Example responses

200 Response

"string"

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.1)

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.1)	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.

configurationGroup

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Configuration Group (v2.1.1)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

Properties

Name	Description
Configuration Group (v2.1.1)	object Represents a configuration group. This schema was resolved from configurations/configurationGroup.
_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 name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: "[a-zA-Z][-\\w_]*"
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096
schema	configurationSchema The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from configurations/configurationSchema.
values	configurationValues The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema. This schema was resolved from configurations/configurationValues.

configurationGroupSummary

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary (v2.1.1)

A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

Properties

Name	Description
Configuration Group Summary (v2.1.1)	object A summary of the data contained within a configuration group resource. This schema was resolved from configurations/configurationGroupSummary.
_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 name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: "[a-zA-Z][-\\w_]*"
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096

configurationGroups

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Configuration Group Collection (v2.1.1)

Collection of configuration groups. 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).

This schema was resolved from configurations/configurationGroups.

Properties

Name	Description
Configuration Group Collection (v2.1.1)	object Collection of configuration groups. 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). This schema was resolved from configurations/configurationGroups.
_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	configurationGroupsEmbedded Embedded objects.
_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.

configurationGroupsEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.1/profile.json",
      "_links": {
        "self": {
          "href": "/configurations/groups/basic"
        }
      },
      "name": "basic",
      "label": "Basic Settings",
      "description": "The basic settings for the Transfers API"
    }
  ]
}

Configuration Groups Embedded Objects (v1.1.1)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

Name	Description
Configuration Groups Embedded Objects (v1.1.1)	object Objects embedded in the configurationGroupscollection. This schema was resolved from configurations/configurationGroupsEmbedded.
items	array: [configurationGroupSummary] An array containing a page of configuration group items. items: object

configurationSchema

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema (v2.1.0)

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

Properties

Name	Description
Configuration Schema (v2.1.0)	object The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from configurations/configurationSchema.
Configuration Schema Value (v2.0.0)	configurationSchemaValue The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

Name	Description
Configuration Schema Value (v2.0.0)	object The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

Name	Description
Configuration Value (v2.0.0)	object The data associated with this configuration. This schema was resolved from configurations/configurationValue.

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Configuration Values (v2.0.0)

The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

Properties

Name	Description
Configuration Values (v2.0.0)	object The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema. This schema was resolved from configurations/configurationValues.
Configuration Value (v2.0.0)	configurationValue The data associated with this configuration. This schema was resolved from configurations/configurationValue.

createOperator

{
  "_profile": "https://production.api.apiture.com/schemas/operators/createOperator/v1.1.1/profile.json",
  "_links": {},
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "mobilePhoneNumber": "+19105550155",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator"
    }
  ]
}

Create Financial Institution Operator (v1.1.1)

Representation used to create a new operator. The operator's username is derived from the emailAddress. If the operator exists in the financial institution's identity provider (based on looking up the emailAddress), the firstName, lastName and mobilePhoneNumber are derived from the identity provider. Otherwise, the caller should pass those properties.

Properties

Name	Description
Create Financial Institution Operator (v1.1.1)	object Representation used to create a new operator. The operator's username is derived from the emailAddress. If the operator exists in the financial institution's identity provider (based on looking up the emailAddress), the firstName, lastName and mobilePhoneNumber are derived from the identity provider. Otherwise, the caller should pass those properties.
_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
firstName	string The operator's first name (or given name). maxLength: 80
middleInitial	string The operator's middle name initial. maxLength: 1
mobilePhoneNumber	string The operator's mobile phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
lastName	string The operator's last name (or surname). minLength: 1 maxLength: 80
emailAddress	string(email) (required) The operator's email address. format: email minLength: 8 maxLength: 80
jobTitle	string The operator's job title. minLength: 3 maxLength: 80
roleAssignments	array: [roleReference] (required) A list of roles to assign to the operator. The maximum rank of the roles determines the new users roleRank. minLength: 1 maxLength: 8 items: object

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.1/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.1)

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.1)	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

identityType

"operator"

Identity Type (v1.0.0)

Indicates what type of identity the authenticated user is.

identityType strings may have one of the following enumerated values:

Value	Description
operator	Operator: Financial institution operator with roles managed by the financial institution via the Operators API.
platformAdministrator	Platform Administrator: Platform administrator which roles managed by the platform provider (Apiture).

These enumeration values are further described by the label group named identityType in the response from the getLabels operation.

type: string

enum values: operator, platformAdministrator

labelGroup

{
  "unknown": {
    "label": "Unknown",
    "code": "0",
    "hidden": true
  },
  "under1Million": {
    "label": "Under $1M",
    "code": "1",
    "range": "[0,1000000.00)",
    "variants": {
      "fr": {
        "label": "Moins de $1M"
      }
    }
  },
  "from1to10Million": {
    "label": "$1M to $10M",
    "code": "2",
    "range": "[1000000.00,10000000.00)",
    "variants": {
      "fr": {
        "label": "$1M \\u00e0 $10M"
      }
    }
  },
  "from10to100Million": {
    "label": "$10M to $100M",
    "code": "3",
    "range": "[10000000.00,100000000.00)",
    "variants": {
      "fr": {
        "label": "$10M \\u00e0 $100M"
      }
    }
  },
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  },
  "other": {
    "label": "Other",
    "code": "254"
  }
}

Label Group (v1.0.3)

A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:

• Unknown
• Under $1M
• $1M to $10M
• $10M to $100M
• $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

Properties

Name	Description
Label Group (v1.0.3)	object A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00). This allows the client to let the user select a value from a list, such as the following derived from the labels in the example: Unknown Under $1M $1M to $10M $10M to $100M $100M or more Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }. This schema was resolved from common/labelGroup.
Label Item (v1.0.2)	labelItem An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from common/labelItem.

labelGroups

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Label Groups (v1.1.3)

A set of named groups of labels, each of which contains multiple item labels.

The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00).

This schema was resolved from common/labelGroups.

Properties

Name	Description
Label Groups (v1.1.3)	object A set of named groups of labels, each of which contains multiple item labels. The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00). This schema was resolved from common/labelGroups.
_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
groups	object Groups of localized labels. This maps group names → a group of labels within that group.
» Label Group (v1.0.3)	labelGroup A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00). This allows the client to let the user select a value from a list, such as the following derived from the labels in the example: Unknown Under $1M $1M to $10M $10M to $100M $100M or more Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }. This schema was resolved from common/labelGroup.

labelItem

{
  "label": "Over $100,000,000.00",
  "code": "4",
  "range": "[100000000.00,]",
  "variants": {
    "fr": {
      "label": "Plus de $10M"
    }
  }
}

Label Item (v1.0.2)

An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

Properties

Name	Description
Label Item (v1.0.2)	object An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from common/labelItem.
label	string (required) A label or title which may be used as labels or other UI controls which present a value.
description	string A more detailed localized description of a localizable label.
variants	object The language-specific variants of this label. The keys in this object are RFC 7231 language codes.
» Simple Label (v1.0.0)	simpleLabel A text label and optional description. This schema was resolved from common/simpleLabel.
code	string If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value. minLength: 1
hidden	boolean If true, this item is normally hidden from the User Interface.
range	string The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max], (exclusiveMin,max], [min,exclusiveMax), or (exclusiveMin,exclusiveMax). For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps. pattern: "^[\\[\\(](-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?[\\]\\)]$"

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.

operator

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operator/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {
    "assignedRoles": [
      {
        "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
        "name": "wireOperator",
        "label": "Wire Room Operator",
        "rank": 520,
        "categoryName": "operator",
        "assignable": true,
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/access/roles/0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f"
          }
        }
      }
    ]
  },
  "state": "active",
  "federated": false,
  "roleRank": 520,
  "createdAt": "2021-02-05T05:05:05.375Z",
  "updatedAt": "2021-02-08T05:05:52.375Z"
}

Financial Institution Operator (v1.3.1)

Representation of an FI operator: a employee or staff member at a financial institution who uses the administrative or back office applications to managed digital banking Each operator may have one or more roles, which grant that operator all the API permissions defined by that role.

Properties

Name	Description
Financial Institution Operator (v1.3.1)	object Representation of an FI operator: a employee or staff member at a financial institution who uses the administrative or back office applications to managed digital banking Each operator may have one or more roles, which grant that operator all the API permissions defined by that role.
_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	operatorEmbedded Objects embedded in a user. Use the ?embed= parameter to select which values to embed in the getOperator call.
_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
firstName	string The operator's first name (or given name). maxLength: 80
middleInitial	string The operator's middle name initial. maxLength: 1
mobilePhoneNumber	string The operator's mobile phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
lastName	string The operator's last name (or surname). minLength: 1 maxLength: 80
emailAddress	string(email) The operator's email address. format: email minLength: 8 maxLength: 80
jobTitle	string The operator's job title. minLength: 3 maxLength: 80
_id	string The unique identifier for this operator resource. This is an immutable opaque string. read-only
username	string The operator's login username. read-only minLength: 8 maxLength: 80
state	operatorState The state of the operator. This controls whether the operator is enabled in administrative applications. Inactive users are not granted any roles/permissions when they authenticate. This is not the operator's state in the identity provider. read-only enum values: active, inactive
identityType	identityType Indicates the type of identity. enum values: operator, platformAdministrator
roleAssignments	array: [roleReference] The roles assigned to the operator. This is derived from the operator's roles. read-only items: object
federated	boolean If true, the operator's identity is managed in a federated identity provider rather than solely in the Operators API and Apiture identity provider. This API cannot update or patch federated operators. read-only
roleRank	integer The user's relative role rank. This is the maximum of the rank values of all the operator's assigned roles. read-only minimum: 400 maximum: 599
updatedAt	string(date-time) The RFC 3339 UTC date-time when the operator was updated. read-only format: date-time
createdAt	string(date-time) The RFC 3339 UTC date-time when the operator was created. read-only format: date-time

operatorEmbedded

{
  "assignedRoles": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.0.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,
      "rank": 100,
      "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  ],
  "allRoles": [
    {
      "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.0.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,
      "rank": 100,
      "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9"
    }
  ],
  "permissions": [
    {
      "_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"
    }
  ]
}

Operator Embedded Objects (v1.0.0)

Related objects embedded in a Operator response. Use the ?embed= parameter to select which values to embed in the getOperator call.

Properties

Name	Description
Operator Embedded Objects (v1.0.0)	object Related objects embedded in a Operator response. Use the ?embed= parameter to select which values to embed in the getOperator call.
assignedRoles	array: [summaryRole] All the roles assigned directly to an operator. items: object
allRoles	array: [summaryRole] The union of the operator's assigned roles and the roles which have the assigned roles as an ancestor. items: object
permissions	array: [summaryPermission] An array containing all the effective permission names associated with all the roles that are assigned to the user. items: object

operatorFields

{
  "firstName": "string",
  "middleInitial": "s",
  "mobilePhoneNumber": "+19105550155",
  "lastName": "string",
  "emailAddress": "user@example.com",
  "jobTitle": "string"
}

Financial Institution Operator Fields (v1.0.0)

Common fields of the FI operator resource used to build other model schemas.

Properties

Name	Description
Financial Institution Operator Fields (v1.0.0)	object Common fields of the FI operator resource used to build other model schemas.
firstName	string The operator's first name (or given name). maxLength: 80
middleInitial	string The operator's middle name initial. maxLength: 1
mobilePhoneNumber	string The operator's mobile phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
lastName	string The operator's last name (or surname). minLength: 1 maxLength: 80
emailAddress	string(email) The operator's email address. format: email minLength: 8 maxLength: 80
jobTitle	string The operator's job title. minLength: 3 maxLength: 80

operatorRoleAssignments

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operatorRoleAssignments/v1.1.1/profile.json",
  "_links": {},
  "items": [
    {
      "_id": "d01a2bbc-b67f-438d-82b4-6d2a2f0060dc",
      "name": "customerSuccessManager"
    },
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator"
    }
  ]
}

Operator Role Assignments (v1.1.1)

A list of roles assigned to an operator.

Properties

Name	Description
Operator Role Assignments (v1.1.1)	object A list of roles assigned to an operator.
_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
items	array: [roleReference] An array of roles. items: object

operatorState

"active"

Operator State (v1.0.0)

The state of the operator user's login account. Warning: The values are still under design review and are likely to change.

operatorState strings may have one of the following enumerated values:

Value	Description
active	Active: An operator who is active in administrative applications and will be granted their assigned roles and permissions when they authenticate.
inactive	Inactive: An operator who is inactive in administrative applications. Inactive operators are not granted any assigned roles or permissions when they authenticate.

These enumeration values are further described by the label group named operatorState in the response from the getLabels operation.

type: string

enum values: active, inactive

operators

{
  "_profile": "https://production.api.apiture.com/schemas/operators/operators/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/operators/operators?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/operators/operators"
    }
  },
  "name": "operators",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/operators/summaryOperator/v1.4.1/profile.json",
        "firstName": "Casey",
        "middleInitial": "K",
        "lastName": "Hargrove",
        "emailAddress": "Casey.Hargrove@3rdparty.bank",
        "mobilePhoneNumber": "+19105550155",
        "username": "casey.hargrove@3rdparty.bank",
        "identityType": "operator",
        "federated": false,
        "jobTitle": "Wire Room Operator",
        "category": "operator",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d8df5f3b-c049-4418-a8d1-bc45d0c1f067",
        "_profile": "https://production.api.apiture.com/schemas/operators/summaryOperator/v1.4.1/profile.json",
        "firstName": "Thomas",
        "middleInitial": "M",
        "lastName": "Williams",
        "emailAddress": "Thomas.Williams@3rdparty.bank",
        "mobilePhoneNumber": "+19105555155",
        "username": "thomas.williams@3rdparty.bank",
        "identityType": "operator",
        "federated": false,
        "jobTitle": "Customer Success Manager",
        "category": "operator",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/operators/operators/d8df5f3b-c049-4418-a8d1-bc45d0c1f067"
          }
        }
      }
    ]
  }
}

Financial Institution Operator Collection (v1.3.1)

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

Properties

Name	Description
Financial Institution Operator Collection (v1.3.1)	object Collection of operators. The items in the collection are ordered in the _embedded.items array; the name is operators. 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: [summaryOperator] An array containing a page of operator 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.

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:

Value	Description
system	System Administrative User: System administrative users who manage the deployment.
operator	Financial Institution Operator: Administrator employees of the financial institution such as the deposits manager or the wire room staff, customer support, and so on These financial institution users use administrative and back office applications to manage the digital banking.
customer	Banking Customer User: Banking customers who hold accounts and use applications to perform digital banking. (Reserved for future use.)

This schema was resolved from access/roleCategory.

type: string

enum values: system, operator, customer

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.

This schema was resolved from access/roleReference.

Properties

Name	Description
Role Reference (v1.0.0)	object A reference to a role resource. This schema was resolved from access/roleReference.
_id	string (required) The unique identifier for the role. read-only maxLength: 64
name	string (required) The name of this role. minLength: 6 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9]{0,63}$"
label	string The text label for this role. minLength: 1 maxLength: 128
uri	string(uri) The URI of the role's resource. format: uri

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/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.1)

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.1)	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.

simpleLabel

{
  "label": "Board of Directors",
  "description": "string"
}

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

Properties

Name	Description
Simple Label (v1.0.0)	object A text label and optional description. This schema was resolved from common/simpleLabel.
label	string (required) A label or title which may be used as labels or other UI controls which present a value.
description	string A more detailed localized description of a localizable label.

summaryOperator

{
  "_profile": "https://production.api.apiture.com/schemas/operators/summaryOperator/v1.4.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/operators/operators/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Casey",
  "middleInitial": "K",
  "lastName": "Hargrove",
  "emailAddress": "Casey.Hargrove@3rdparty.bank",
  "identityType": "operator",
  "mobilePhoneNumber": "+19105550155",
  "username": "casey.hargrove@3rdparty.bank",
  "jobTitle": "Wire Room Operator",
  "roleAssignments": [
    {
      "_id": "0f10d993-6fd0-4e4e-aa2b-74ee42fc3a8f",
      "name": "wireOperator",
      "label": "Wire Operator"
    }
  ],
  "_embedded": {}
}

Financial Institution Operator Summary (v1.4.1)

Summary representation of an FI operator resource in the operators 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
Financial Institution Operator Summary (v1.4.1)	object Summary representation of an FI operator resource in the operators 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
firstName	string The operator's first name (or given name). maxLength: 80
middleInitial	string The operator's middle name initial. maxLength: 1
mobilePhoneNumber	string The operator's mobile phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
lastName	string The operator's last name (or surname). minLength: 1 maxLength: 80
emailAddress	string(email) The operator's email address. format: email minLength: 8 maxLength: 80
jobTitle	string The operator's job title. minLength: 3 maxLength: 80
_id	string The unique identifier for this operator resource. This is an immutable opaque string. read-only
username	string The operator's login username. read-only minLength: 8 maxLength: 80
state	operatorState The state of the operator. This controls whether the operator is enabled in administrative applications. Inactive users are not granted any roles/permissions when they authenticate. This is not the operator's state in the identity provider. read-only enum values: active, inactive
identityType	identityType Indicates the type of identity. enum values: operator, platformAdministrator
roleAssignments	array: [roleReference] The roles assigned to the operator. This is derived from the operator's roles. read-only items: object

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:

Rel	Summary	Method
self	Fetch a representation of this permission	GET

This schema was resolved from access/summaryPermission.

Properties

Name	Description
Permission Summary (v1.0.0)	object 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: Rel Summary Method self Fetch a representation of this permission GET This schema was resolved from access/summaryPermission.
_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 name of this permission. This immutable programmatic identifier also acts as the permission's unique {permissionName}. minLength: 6 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9]{0,63}$"
label	string A short text label for this permission, for use in human presentation. This field may be localized. minLength: 1 maxLength: 128

summaryRole

{
  "_profile": "https://production.api.apiture.com/schemas/access/summaryRole/v1.0.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,
  "rank": 100,
  "_id": "7655fcde-c3a4-404e-a662-9beede86bfa9"
}

Role Summary (v1.0.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:

Rel	Summary	Method
self	Fetch a representation of this role	GET

This schema was resolved from access/summaryRole.

Properties

Name	Description
Role Summary (v1.0.0)	object 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: Rel Summary Method self Fetch a representation of this role GET This schema was resolved from access/summaryRole.
_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 name of this role. This immutable programmatic identifier also acts as the role's unique {role}. minLength: 6 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9]{0,63}$"
label	string The text label for this role, for use in human presentation. This field may be localized. minLength: 1 maxLength: 128
categoryName	roleCategory The category of users that may be assigned this role. Child roles are constrained: a customer role can only have customer child roles. a operator role can only have customer or operator child roles. a system role can have any child roles. enum values: system, operator, customer
rank	integer The role's integer rank, to allow relative comparisons of roles. minimum: 0 maximum: 999
assignable	boolean If true, this role can be assigned to users. If false, the role is used for composing other roles only. default: false
_id	string The unique identifier for this role. This is an immutable opaque string. This is the {role} in canonical resource URIs. read-only maxLength: 64

---