Cases v0.14.1

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 Cases API tracks work tasks for operators to perform bank servicing.

A case represents a unit of work or a task that an operator at a financial institution performs. Cases are assigned to operators. Each case has a type which determines what type of action the operator needs to perform (for example, review/adjudicate an account application; review/approve an address change, review/submit a wire transfer request, stop a check, respond to a customer-initiated message, close an account, resolve a transaction dispute, unfreeze or unlock an account, change another operator's role, etc.)

Most cases have an associated business object: a resource in Digital Banking that the case is attached to, such as an account, an application, a transaction, a statement. The business object is not required. The type of the business object depends on the case type.

Clients can list cases (with filtering, pagination), create new cases or get all of a case's details. Clients may also list cases and associated account applications or enrollments, with any associated cases embedded in them.

Cases are not directly mutable: there is no PUT or PATCH operation to update a case resource and no DELETE to delete cases. All the properties are either assigned when the case is created, or are updated from other Case Action operations, or are derived. Cases have a state which tracks their progress:

• new - The initial state of a case. Not assigned, and no activity on the case.
• active - The case has been assigned or other activity, such as a note added or an operator posted a message
• blocked - The assignee is blocked from making progress on the case due to some external reason.
• canceled - The work is no longer needed.
• closed - The assignee has completed all the work for the task.

Case action operations include:

• Assign the case to the current operator or the current non-operator administrator.
• Unassign the case.
• Make a case active.
• Cancel a case.
• Mark a case as blocked. (This operation is to be added in a future update.)
• Mark a case as closed.

Each case also has a set of notes attached to it. Notes are created with createCaseNote. The text of a note supports Markdown notation and thus can include hypermedia links or numbered/bullet lists, emphasis, etc.

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.

cannotAssignUser

Description: The caller cannot pass the userId of another user.
Remediation: Pass the _id of the currently authenticated User, or omit the userId when creating a case for the currently authenticated user Only operators may pass in arbitrary users when creating cases.

duplicateCaseExists

Description: There is already an existing case with this type and business object.
Remediation: Refer to the existing case.

invalidBusinessObjectState

Description: The state of this case's business object does not allow this operation.
Remediation: Use only the available links on the case resource.

invalidBusinessObjectUri

Description: The business object URI does not refer to a valid object in the Apiture system, or the resource URI is not the correct resource type for the case type.
Remediation: Use only a resource in the existing Apiture system.

invalidCaseState

Description: The case state does not allow this operation.
Remediation: Use only the available links on the case resource.

messageThreadAlreadySet

Description: There is already a message thread attached to this case.
Remediation: Use the existing message thread resource for communication.

messageThreadInUse

Description: The given message thread is already associated with another case.
Remediation: Use a (new) message thread resource that is not associated with another case.

noSuchAssignee

Description: No such operator or other identity for the assignee passed in the request.
Remediation: Pass the ID of an existing operator, or omit the property to create an unassigned case.

noSuchCase

Description: There is no such case resource for the given case ID.
Remediation: Pass the ID of an existing case.

noSuchCaseNote

Description: There is no such case note resource for the given case note ID.
Remediation: Pass the ID of an existing case note.

noSuchMessageThread

Description: There is no such message thread for the given message thread URI.
Remediation: Pass the URI of an existing message thread.

noSuchMessageThreadId

Description: There is no such message thread resource for the given message thread ID.
Remediation: Pass the_id of an existing message thread.

noSuchUser

Description: No such user for the userId passed in the request.
Remediation: Pass the _id of an existing user.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

Authentication

• 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
admin/delete	Delete access to system configuration.
admin/full	Full access to system configuration.
admin/read	Read access to system configuration.
admin/write	Write (update) access to system configuration.

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

Cases

Cases

getCases

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of cases

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

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

Parameters

Parameter	Description
assignedToMe in: query	boolean Subset the response to only cases assigned (true) or not assigned (false) to the current operator/administrator making the API call.
assignee in: query	string Subset the response to only cases which are assigned to the identity whose ID exactly matches the parameter. The assignee is typically the _id of the operator resource from the Operators API, but it may also be the ID of a non-operator administrator. maxLength: 48
state in: query	array[string] Match cases by state. This matches any of the values in the |-separated list from the caseState enumeration. See also the completed query parameter. Example: ?state=active|blocked. unique items minItems: 1 pipe-delimited items: string » enum values: new, active, canceled, blocked, closed
completed in: query	boolean If true, subset the response to only cases whose state is a completed state, equivalent to ?state=closed|canceled. If false, subset the response to only cases whose state is an unclosed state, equivalent to ?state=new|blocked|active. This query parameter is preferred over the equivalents since it more concise and it will continue to work if new states are added.
userId in: query	string Match cases that are associated to the given userId. The userId is the _id of a User from the Users API.
start in: query	integer(int64) The zero-based index of the first case 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 case 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: • type • state • userLastName • userFirstName • assigneeLastName • assigneeLastName • createdAt • updatedAt.
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions: • Property type using functions in, eq • Property state using functions in, eq • Property userFirstName using functions eq, contains, startsWith • Property userLastName using functions eq, contains, startsWith • Property userId using functions eq • Property assignee using functions eq • Property assigneeFirstName using functions eq, contains, startsWith • Property assigneeLastName using functions eq, contains, startsWith • Property createdAt using functions lt, le, gt, ge • Property updatedAt using functions lt, le, gt, ge • Property number using functions eq, in, lt, le, gt, ge.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/cases/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=10&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/cases/cases"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=20&limit=10"
    }
  },
  "name": "cases",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d",
        "number": 76908,
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCase/v2.0.0/profile.json",
        "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
        "type": "accountApplicationReview",
        "state": "active",
        "assignee": "f7a9ece0-364e",
        "assigneeFirstName": "William",
        "assigneeLastName": "Carlson",
        "userFirstName": "Elsa",
        "userLastName": "Snowqueen",
        "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
        "lastMessageAuthor": {
          "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
          "name": "William Carlson",
          "type": "operator",
          "createdAt": "2021-10-18T12:44:13.375Z"
        },
        "_links": {
          "apiture:assignee": {
            "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e"
          },
          "apiture:user": {
            "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
          },
          "self": {
            "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
          }
        }
      }
    ]
  },
  "count": 1,
  "limit": 10,
  "start": 10
}

Responses

createCase

Code samples

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

POST https://api.devbank.apiture.com/cases/cases 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/cases/createCase/v1.2.1/profile.json",
  "_links": {
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "type": "generalInquiry",
  "assignee": "f7a9ece0-364e"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

};

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Create a new case

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

Create a new case. If an assignee is passed, the case is created in the active state, otherwise it is created in the new state. Note that this operation does not allow creating a duplicate case if an existing case with this type and business object exists and it is not closed or canceled.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/cases/createCase/v1.2.1/profile.json",
  "_links": {
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "type": "generalInquiry",
  "assignee": "f7a9ece0-364e"
}

Parameters

Parameter	Description
body	createCase The data necessary to create a new case.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

getCase

Code samples

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

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

};

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

};

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Fetch a representation of this case

GET https://api.devbank.apiture.com/cases/cases/{caseId}

Return a HAL representation of this case 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] If set, the returned case representation will include additional related objects in the _embedded object property. embed supports the following values: notes: Include the case's notes object businessObject: Include the case's business object messageThread: Include the case's message thread The default is no embedded resources. unique items minItems: 0 maxItems: 3 comma-delimited items: string » enum values: businessObject, notes, messageThread
caseId in: path	string (required) The unique identifier of this case. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

lookupCase

Code samples

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

GET https://api.devbank.apiture.com/cases/case HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Look up a case instance

GET https://api.devbank.apiture.com/cases/case

Look up a case by its case number or by the associated message thread. Return a HAL representation of the case resource, or a 404 Not Found response if no such case exists. Exactly one of the messageThread or number parameters is required.

Parameters

Parameter	Description
messageThread in: query	string Return a case that is associated with a message thread. The messageThread is the _id of a message thread from the Messages API. minLength: 16 maxLength: 48
number in: query	integer Look up a case by its case number.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

Case Notes

Case Notes

getCaseNotes

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return a list of case notes

GET https://api.devbank.apiture.com/cases/cases/{caseId}/notes

Return a list of notes attached to this case. The notes are in chronological order, oldest to newest.

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/caseNotes/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "items": [
    {
      "_id": "0399abed-fd3d",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/6b8be842-d8de/notes/0399abed-fd3d"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-03-31T10:08:49.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Waiting on Walter"
    },
    {
      "_id": "d62c0701-0d74",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/6b8be842-d8de/notes/d62c0701-0d74"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-04-01T10:09:19.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Unassigned this case as I'm going on PTO"
    }
  ]
}

Responses

createCaseNote

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/cases/cases/{caseId}/notes \
  -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/cases/cases/{caseId}/notes 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/cases/createCaseNote/v1.0.2/profile.json",
  "_links": {},
  "text": "Waiting on Walter"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/cases/cases/{caseId}/notes',
{
  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/cases/cases/{caseId}/notes',
  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/cases/cases/{caseId}/notes',
  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/cases/cases/{caseId}/notes', params={

}, headers = headers)

print r.json()

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

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

Create a new case note

POST https://api.devbank.apiture.com/cases/cases/{caseId}/notes

Add a note to the case's list of notes. If the case's state is new, this changes the state to active.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/cases/createCaseNote/v1.0.2/profile.json",
  "_links": {},
  "text": "Waiting on Walter"
}

Parameters

Parameter	Description
body	createCaseNote The data necessary to create a new case note.
caseId in: path	string (required) The unique identifier of this case. This is an opaque string.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/caseNote/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
    }
  },
  "_id": "0399abed-fd3d",
  "createdAt": "2021-03-31T10:18:44.375Z",
  "createdBy": "aea1b29f-cd66",
  "text": "waiting on Walter",
  "_embedded": {}
}

Responses

getCaseNote

Code samples

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

}, headers = headers)

print r.json()

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

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

Fetch a representation of this case note

GET https://api.devbank.apiture.com/cases/cases/{caseId}/notes/{noteId}

Return a HAL representation of this case note 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.
caseId in: path	string (required) The unique identifier of this case. This is an opaque string.
noteId in: path	string (required) The unique identifier of this case note. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/caseNote/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
    }
  },
  "_id": "0399abed-fd3d",
  "createdAt": "2021-03-31T10:18:44.375Z",
  "createdBy": "aea1b29f-cd66",
  "text": "waiting on Walter",
  "_embedded": {}
}

Responses

Case Actions

Actions on Cases

cancelCase

Code samples

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

POST https://api.devbank.apiture.com/cases/canceledCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/cases/canceledCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/cases/canceledCases',
  params: {
  'case' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/cases/canceledCases', params={
  'case': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/cases/canceledCases?case=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"},
        "Authorization": []string{"Bearer {access-token}"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Cancel a case

POST https://api.devbank.apiture.com/cases/canceledCases

Cancel a case. This changes the state property of the case to canceled. This operation is available via the apiture:cancel link on the case resource if the state of the business object allows the case to be cancel. For example, an accountApplicationReview case may be canceled only if the associated application business object is canceled or expired. A case cannot be canceled if the state is closed. The response is the updated representation of the case. This operation is idempotent: no changes are made if the case is already canceled. The If-Match request header value, if passed, must match the current entity tag value of the case.

Parameters

Parameter	Description
case in: query	string (required) A string which uniquely identifies a case to cancel. This may be the unique caseId or the URI of the case.
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/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

closeCase

Code samples

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

POST https://api.devbank.apiture.com/cases/closedCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/cases/closedCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/cases/closedCases',
  params: {
  'case' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/cases/closedCases', params={
  'case': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/cases/closedCases?case=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"},
        "Authorization": []string{"Bearer {access-token}"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Mark a case as closed

POST https://api.devbank.apiture.com/cases/closedCases

Close a case. This changes the state property of the case to closed. This operation is available via the apiture:close link on the case resource, if and only if the state is new or active and the business object is in a state that allows the case to be closed. For example, an accountApplicationReview case may be closed only if the associated application business object is approved or rejected. This operation is available as the apiture:close link on a case, if the action is allowed.

The response is the updated representation of the case. This operation is idempotent: no changes are made if the case is already closed. The If-Match request header value, if passed, must match the current entity tag value of the case. This operation is available as the apiture:case link on a case, if the action is allowed.

Parameters

Parameter	Description
case in: query	string (required) A string which uniquely identifies a case to close. This may be the unique caseId or the URI of the case.
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/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

activateCase

Code samples

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

POST https://api.devbank.apiture.com/cases/activeCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/cases/activeCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/cases/activeCases',
  params: {
  'case' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/cases/activeCases', params={
  'case': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/cases/activeCases?case=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"},
        "Authorization": []string{"Bearer {access-token}"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Re-activate a case.

POST https://api.devbank.apiture.com/cases/activeCases

Activate (re-open) a closed or canceled case so that an operator can work on it. This changes the state of the case to active and adds a note recording the change. This operation is available as the apiture:activate link on a case, if the action is allowed.

The response is the updated representation of the case. This operation is idempotent: no changes are made if the case is already active. The If-Match request header value, if passed, must match the current entity tag value of the case.

Parameters

Parameter	Description
case in: query	string (required) The unique identifier of a case to activate. This is the _id property of case resource.
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/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

unassignCase

Code samples

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

POST https://api.devbank.apiture.com/cases/unassignedCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/cases/unassignedCases?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/cases/unassignedCases',
  params: {
  'case' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/cases/unassignedCases', params={
  'case': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/cases/unassignedCases?case=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"},
        "Authorization": []string{"Bearer {access-token}"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Remove the operator assignment

POST https://api.devbank.apiture.com/cases/unassignedCases

Unassign an active or blocked case by removing the assignee from a case. This operation also adds a note to the case indicating that it has been unassigned. This does not change the state of the case.

The response is the updated representation of the case. This operation is idempotent: no changes are made if the case is already unassigned. The If-Match request header value, if passed, must match the current entity tag value of the case.

This operation is not allowed if the case is canceled or closed; (activate the case first, then unassign it.) This is also not allowed on new cases, since new cases do not have assignees.

Parameters

Parameter	Description
case in: query	string (required) A string which uniquely identifies a case to unassign. This may be the unique caseId or the URI of the case.
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/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

assignCaseToMe

Code samples

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

POST https://api.devbank.apiture.com/cases/assignedToMe?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/cases/assignedToMe?case=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',
  'Authorization':'Bearer {access-token}',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/cases/assignedToMe',
  params: {
  'case' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/cases/assignedToMe', params={
  'case': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/cases/assignedToMe?case=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"},
        "Authorization": []string{"Bearer {access-token}"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Assign a case to the caller

POST https://api.devbank.apiture.com/cases/assignedToMe

Assign the case (identified in the ?case= query parameter) to the current operator (identified by the Authorization header).

This operation updates the assignee. If the case's state is new, this changes the state to active. This operation adds a case note recording the new assignee and (if applicable) the state change.

This operation is idempotent: no changes are made if the case is already assigned to the operator. Note: this operation has no request body. This operation is not allowed if the case is closed or canceled; (activate the case first, then unassign it.)

Parameters

Parameter	Description
case in: query	string (required) The unique identifier of a case to assign to the current user. This is the _id property of case resource.
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/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

Applications

Account Applications

getApplications

Code samples

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

GET https://api.devbank.apiture.com/cases/applications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of account applications or enrollments and their associated cases (if any)

GET https://api.devbank.apiture.com/cases/applications

Return a paginated sortable filterable collection of records containing details of account applications or account enrollments with associated case properties. The links in the response include pagination links.

For a request such as

GET /cases/applications?state=blocked&sortBy=accountTarget,productName

each item in the response's _embedded.items is a applicationReview object as outlined below:

  items:
    - { type: accountApplication, _id: abc123, state: blocked,  ...,
        caseNumber: 328, assignee: op333777, caseState: active }
    - { type: enrollment,         _id: def234, state: canceled, ... }
    - { type: accountApplication, _id: ghi345, state: blocked,  ...,
        caseNumber: 865, assignee: op888555, caseState: active }
    - { type: enrollment,         _id: jkl456, state: blocked,  ...,
        caseNumber: 701, assignee: op333777, caseState: active }
    - { type: accountApplication, _id: mno567, state: approved,  ...,
        caseNumber: 957, assignee: op333777, caseState: closed }
    - { type: enrollment,         _id: pqr678, state: approved, ... }
    - { type: accountApplication, _id: stu234, state: canceled, ... }
    - { type: accountApplication, _id: vwx890, state: approved, ... }

Note that only some applications and enrollments have cases. If no case exists, the case properties are omitted from the item in the response.

If the operator with the _id of op333777 invokes the call

GET /applications?state=blocked&assignedToMe=true&caseState=active&sortBy=accountTarget,productName,

the response is all applications that have an accountApplicationReview or accountCoOwnerEnrollmentReview case assigned to that operator and whose case state is active (not canceled or closed). Only cases 328 and 701 from the above example satisfy the case filters and the response above from is reduced to the response below.

  items:
    - { type: accountApplication, _id: abc123, state: blocked,  ...,
        caseNumber: 328, assignee: op333777, caseState: active }
    - { type: enrollment,         _id: jkl456, state: blocked,  ...,
        caseNumber: 701, assignee: op333777, caseState: active }

Note that when using case filters caseState, caseCompleted, assignedToMe, assignee, assigneeFirstName, assigneeLastName, applications and enrollments that have no cases are not returned.

Parameters

Parameter	Description
type in: query	string Match item records by their type. enum values: accountApplication, jointOwnerEnrollment, authorizedSignerEnrollment
applicationState in: query	array[string] Match account applications or enrollments by their application state. This matches any of the values in the |-separated list from the applicationState enumeration. Example: ?applicationState=active|blocked. unique items minItems: 1 pipe-delimited items: string » enum values: new, active, canceled, blocked, closed
applicant in: query	string Filter applications by applicant ID. The value must be an applicant user's _id. An application or enrollment resource is included in the response if and only if the named user is among the application's applicants or matches the enrollee.
assignedToMe in: query	boolean Subset the response to only applications and enrollments with cases assigned (true) or not assigned (false) to the current operator/administrator making the API call.
assignee in: query	string Subset the response to only applications and enrollments which are assigned to the identity whose ID exactly matches the parameter. The assignee is typically the _id of the operator resource from the Operators API, but it may also be the ID of a non-operator administrator. maxLength: 48
caseState in: query	array[string] Match applications and enrollments that have cases in this state. This matches any of the values in the |-separated list. The array items must be in the enumeration defined by caseState. See also the caseCompleted query parameter. Example: ?caseState=new|active. unique items minItems: 1 pipe-delimited items: string
caseCompleted in: query	boolean If true, subset the response to only records whose cases state is a completed state, equivalent to ?caseState=closed|canceled. If false, subset the response to only cases whose state is an unclosed state, equivalent to ?caseState=new|blocked|active. This query parameter is preferred over the equivalents since it more concise and it will continue to work if new states are added.
reviewedBy in: query	string Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected. maxLength: 48
start in: query	integer(int64) The zero-based index of the first account application resource 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 account applications resources to return in this page. format: int32 default: 100
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions: • Property type using functions eq, ne, in • Property businessObjectType using functions eq, ne, in • Property state using functions eq, ne, in • Property caseState using functions eq, ne, in • Property caseType using functions eq, ne, in • Property caseNumber using functions lt, le, gt, ge, eq, ne, in • Property flaggedForReview using functions eq, ne • Property productName using functions eq, startsWith, contains • Property accountName using functions eq, startsWith, contains • Property productTarget using functions eq, in • Property firstName using functions eq, startsWith, contains • Property lastName using functions eq, startsWith, contains • Property userId using functions eq • Property assigneeFirstName using functions eq, startsWith, contains • Property assigneeLastName using functions eq, startsWith, contains • Property assignedToMe using functions eq, ne • Property assignee using functions eq • Property reviewedBy using functions eq • Property createdAt using functions lt, le, gt, ge • Property updatedAt using functions lt, le, gt, ge • Property caseCreatedAt using functions lt, le, gt, ge • Property caseUpdatedAt using functions lt, le, gt, ge • Property completedAt using functions lt, le, gt, ge.
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: • applicantName • productName • productTarget • organizationName • workflowState • createdAt • reviewedAt • lastName • firstName • reviewerLastName • reviewerFirstName • assigneeLastName • assigneeFirstName • caseState • caseCreatedAt • caseUpdatedAtAt • createdAt • updatedAt • completedAt.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/accountApplications/v3.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "applications and enrollments",
  "_embedded": {
    "items": [
      {
        "type": "accountApplication",
        "businessObjectType": "accountApplication",
        "applicationState": "blocked",
        "flaggedForReview": true,
        "accountName": "Our Shared Checking Account",
        "productName": "Interest-Free Checking",
        "accountTarget": "personal",
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
        "assignee": "f7a9ece0-364e",
        "assigneeFirstName": "William",
        "assigneeLastName": "Carlson",
        "caseNumber": 76908,
        "caseType": "accountApplicationReview",
        "caseState": "active",
        "_links": {
          "apiture:accountApplication": {
            "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "apiture:case": {
            "href": "https://api.devbank.apiture.com/case/case/aec98ecb-472a-4ad5-9ca0-bde63c140282"
          },
          "apiture:applicant": {
            "href": "https://api.devbank.apiture.com/users/users/cd307bfc-a575-4f07-9320-dc960baf822d"
          },
          "apiture:assignee": {
            "href": "https://api.devbank.apiture.com/operators/operators/a827a4cb-80a7-4cd0-96fb-f04faae45d02"
          }
        }
      }
    ]
  }
}

Responses

Message Threads

Communication between the customer and operators

setMessageThread

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/cases/cases/{caseId}/messageThread?messageThread=string \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/cases/cases/{caseId}/messageThread?messageThread=string 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/cases/cases/{caseId}/messageThread?messageThread=string',
{
  method: 'PUT',

  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/cases/cases/{caseId}/messageThread',
  method: 'put',
  data: '?messageThread=string',
  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.put 'https://api.devbank.apiture.com/cases/cases/{caseId}/messageThread',
  params: {
  'messageThread' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/cases/cases/{caseId}/messageThread', params={
  'messageThread': 'string'
}, headers = headers)

print r.json()

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

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

Assign a message thread to the case.

PUT https://api.devbank.apiture.com/cases/cases/{caseId}/messageThread

Assign a secure message thread to this case. The operators and banking customer can communicate securely by posting messages and attachments to this resource. The message thread object is available in the apiture:messageThread link in the case resource.

This operation is idempotent: no changes are made if the message thread is already associated with the case. Clients can also find the case associated with a message thread via the lookupCase operation.

Parameters

Parameter	Description
messageThread in: query	string (required) The ID of a message thread resource.
caseId in: path	string (required) The unique identifier of this case. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Responses

API

The Cases API

getApi

Code samples

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

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

}, headers = headers)

print r.json()

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

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

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

}, headers = headers)

print r.json()

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

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

Return API definition document

GET https://api.devbank.apiture.com/cases/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/cases/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

Localized Labels

GET https://api.devbank.apiture.com/cases/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

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

accountApplications

{
  "_profile": "https://production.api.apiture.com/schemas/cases/accountApplications/v3.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "applications and enrollments",
  "_embedded": {
    "items": [
      {
        "type": "accountApplication",
        "businessObjectType": "accountApplication",
        "applicationState": "blocked",
        "flaggedForReview": true,
        "accountName": "Our Shared Checking Account",
        "productName": "Interest-Free Checking",
        "accountTarget": "personal",
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
        "assignee": "f7a9ece0-364e",
        "assigneeFirstName": "William",
        "assigneeLastName": "Carlson",
        "caseNumber": 76908,
        "caseType": "accountApplicationReview",
        "caseState": "active",
        "_links": {
          "apiture:accountApplication": {
            "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "apiture:case": {
            "href": "https://api.devbank.apiture.com/case/case/aec98ecb-472a-4ad5-9ca0-bde63c140282"
          },
          "apiture:applicant": {
            "href": "https://api.devbank.apiture.com/users/users/cd307bfc-a575-4f07-9320-dc960baf822d"
          },
          "apiture:assignee": {
            "href": "https://api.devbank.apiture.com/operators/operators/a827a4cb-80a7-4cd0-96fb-f04faae45d02"
          }
        }
      }
    ]
  }
}

Account Applications (v3.0.0)

heterogeneous collection of account applications and enrollments. The items in the collection are ordered in the _embedded object with name items. The items in the collection are applicationReview items, each may contain a summaryCase object in the _embedded.case property.

The top-level _links object may contain pagination links: self, next, prev, first, last, collection.

Note: This collection does not provide API operations to GET the records in the response; they are not separate resources.

Properties

Name	Description
Account Applications (v3.0.0)	object heterogeneous collection of account applications and enrollments. The items in the collection are ordered in the _embedded object with name items. The items in the collection are applicationReview items, each may contain a summaryCase object in the _embedded.case property. The top-level _links object may contain pagination links: self, next, prev, first, last, collection. Note: This collection does not provide API operations to GET the records in the response; they are not separate resources.
_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 resources.
» items	array: [applicationRecord] An array containing a page of account application 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.

applicationPlatform

"web"

Application Platform (v1.0.0)

The client application platform type.

applicationPlatform strings may have one of the following enumerated values:

Value	Description
web	Web Application
android	Android Application
ios	iOS Application

This schema was resolved from messages/applicationPlatform.

type: string

enum values: web, android, ios

applicationRecord

{
  "type": "accountApplication",
  "businessObjectType": "accountApplication",
  "applicationState": "blocked",
  "flaggedForReview": true,
  "accountName": "Our Shared Checking Account",
  "productName": "Interest-Free Checking",
  "accountTarget": "personal",
  "firstName": "Elsa",
  "lastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "reviewedBy": "f7a9ece0-364e",
  "assignee": "f7a9ece0-364e",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "caseNumber": 76908,
  "caseType": "accountApplicationReview",
  "caseState": "active",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "_links": {
    "apiture:accountApplication": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
    },
    "apiture:case": {
      "href": "https://api.devbank.apiture.com/case/case/aec98ecb-472a-4ad5-9ca0-bde63c140282"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/cd307bfc-a575-4f07-9320-dc960baf822d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/a827a4cb-80a7-4cd0-96fb-f04faae45d02"
    }
  }
}

Application Record (v2.0.0)

Details of an account application or an enrollment, with associated case details, if any.

Links

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

Rel	Summary	Method
apiture:accountApplication	Associated account application, if any	GET
apiture:enrollment	Associated enrollment, if any	GET
apiture:assignee	Case assignee	GET
apiture:applicant	Applicant	GET
apiture:case	Fetch a representation of this case	GET

Properties

Name	Description
Application Record (v2.0.0)	object Details of an account application or an enrollment, with associated case details, if any. Links Response and request bodies using this applicationRecord schema may contain the following links: Rel Summary Method apiture:accountApplication Associated account application, if any GET apiture:enrollment Associated enrollment, if any GET apiture:assignee Case assignee GET apiture:applicant Applicant GET apiture:case Fetch a representation of this case GET
type	string (required) Indicates the type of application or enrollment data in this record. enum values: accountApplication, jointOwnerEnrollment, authorizedSignerEnrollment
businessObjectType	string (required) Indicates if this item is associated with an account application or an account enrollment. If businessObjectType is accountApplication, the link with the rel apiture:accountApplication links to the corresponding application resource; if businessObjectType is enrollment, the link with the rel apiture:enrollment links to the corresponding enrollment resource. enum values: accountApplication, enrollment
applicationState	applicationState (required) The state of the associated account application or enrollment. enum values: pending, running, blocked, canceled, expired, rejected, approved
flaggedForReview	boolean (required) Indicates if the application or enrollment has been flagged for financial institution review.
accountName	string (required) The name of associated banking account. maxLength: 128
productName	string (required) The name of associated banking account product maxLength: 128
accountTarget	productTarget (required) Whether the account is personal or checking. enum values: personal, business
firstName	string (required) The first name of the account applicant or enrollee. read-only maxLength: 80
lastName	string (required) The first name of the account applicant or enrollee. read-only maxLength: 80
userId	string (required) The _id of the account applicant or enrollee user from the Users API. read-only maxLength: 48
reviewedBy	string The ID of the operator who reviewed and approved or rejected the application or enrollment. The value "<system>" indicates that the system automatically approved or rejected the application or enrollment. This property is only set if automatically reviewed or if the resource has been rejected or approved. maxLength: 48
reviewerFirstName	string The first name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention. read-only maxLength: 80
reviewerLastName	string The last name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention. read-only maxLength: 80
assignee	string The _id of the operator or other identity assigned to this case, if any. read-only maxLength: 48
assigneeFirstName	string The first name of the operator or other identity assigned to the case, if any. read-only maxLength: 80
assigneeLastName	string The last name of the operator or other identity assigned to the case, if any. read-only maxLength: 80
caseNumber	integer This case's sequential number, for easy reference. minimum: 0
caseType	caseType The type of case this is; omitted if there is no case associated with this item. enum values: accountApplicationReview, accountCoOwnerEnrollmentReview, authorizedSignerReview, externalAccountReview, generalInquiry, transactionInquiry, transactionDispute
caseState	caseState The state of the case resource associated with this item; omitted if there is no case associated with this item. enum values: new, active, canceled, blocked, closed
createdAt	string(date-time) (required) The date-time when the application or enrollment was created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
updatedAt	string(date-time) The date-time when the application or enrollment was last modified. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
completedAt	string(date-time) The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ read-only format: date-time
caseCreatedAt	string(date-time) The date-time when the corresponding case was created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
caseUpdatedAt	string(date-time) The date-time when the case was last modified. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
_links	links (required) 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.

applicationState

"approved"

Application State (v1.0.0)

The state of the enrollment or application.

applicationState strings may have one of the following enumerated values:

Value	Description
pending	Pending: Available to be started (POST to the apiture:start link to start it). This state is reserved for future use.
running	Running: Started and has not completed or been canceled.
blocked	Blocked: Started but is blocked; there are no available workflow tasks.
canceled	Canceled: Canceled prior to completion.
expired	Expired: Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired.
rejected	Rejected: Completed but was rejected after review.
approved	Approved: Completed and approved.

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

This schema was resolved from accountApplications/applicationState.

type: string

enum values: pending, running, blocked, canceled, expired, rejected, approved

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

case

{
  "_profile": "https://production.api.apiture.com/schemas/cases/case/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e-1c00d0890052"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    },
    "apiture:assignCaseToMe": {
      "href": "https://api.devbank.apiture.com/cases/assignedToMe?case=0399abed-fd3d"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/cases/closedCases?case=0399abed-fd3d"
    },
    "apiture:cancel": {
      "href": "https://api.devbank.apiture.com/cases/canceledCases?case=0399abed-fd3d"
    },
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e-1c00d0890052",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  },
  "createdAt": "2021-03-31T05:55:12.375Z",
  "_embedded": {
    "businessObject": {
      "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
      "accountApproval": {},
      "accountName": "My Premiere Savings",
      "applicantName": "Elsa Snowqueen",
      "applicants": [],
      "consents": [],
      "createdAt": "2018-12-13T11:01:41.375Z",
      "documents": [],
      "fundingAccount": {
        "title": "Elsa Snowqueen",
        "accountNumbers": {
          "full": "9876543210",
          "masked": "*************3210"
        },
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021"
      },
      "fundingAmount": {
        "currency": "USD",
        "value": "1500.00"
      },
      "organization": {},
      "productName": "Premiere Savings",
      "products": [],
      "state": "running",
      "workflowState": "running"
    },
    "notes": [
      {
        "_id": "0399abed-fd3d",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-03-31T10:08:49.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Waiting on Walter"
      },
      {
        "_id": "d62c0701-0d74",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
          }
        },
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
        "createdAt": "2021-04-01T10:09:19.375Z",
        "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
        "text": "Unassigned this case as I'm going on PTO"
      }
    ]
  },
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Case (v2.0.0)

A case represents a trackable unit of servicing work assignable to an operator.

Links

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

Rel	Summary	Method
self	Fetch a representation of this case	GET
apiture:activate	Re-activate a case.	POST
apiture:assignCaseToMe	Assign a case to the caller	POST
apiture:unassign	Remove the operator assignment	POST
apiture:cancel	Cancel a case	POST
apiture:close	Mark a case as closed	POST
apiture:user	The case's banking User resource	GET
apiture:assignee	The operator assigned to this case	GET
apiture:messageThread	A secure message thread for communicating with the banking customer	GET

Properties

Name	Description
Case (v2.0.0)	object A case represents a trackable unit of servicing work assignable to an operator. Links Response and request bodies using this case schema may contain the following links: Rel Summary Method self Fetch a representation of this case GET apiture:activate Re-activate a case. POST apiture:assignCaseToMe Assign a case to the caller POST apiture:unassign Remove the operator assignment POST apiture:cancel Cancel a case POST apiture:close Mark a case as closed POST apiture:user The case's banking User resource GET apiture:assignee The operator assigned to this case GET apiture:messageThread A secure message thread for communicating with the banking customer GET
_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	caseEmbeddedObjects Objects embedded in a case
_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
number	integer This case's sequential number, for easy reference. minimum: 0
userFirstName	string The first name of the banking customer user that this case is for. read-only
userLastName	string The first name of the banking customer user that this case is for. read-only
userId	string The _id of the user (bank customer) associated with this case, from the Users API. This is the userId passed to the createCase operation. read-only maxLength: 48
assignee	string The ID of the operator or other identity assigned to this case, if any. This is immutable in a case (no PUT update), but an operator may change this via the assignCaseToMe operation. read-only maxLength: 48
assigneeFirstName	string The first name of the operator or other identity assigned to this case, if any. This is derived from the access token used when the case is assigned or from the assignee ID passed when creating a case. read-only maxLength: 32
assigneeLastName	string The last name of the operator or other identity assigned to this case, if any. This is derived from the access token used when the case is assigned or from the assignee ID passed when creating a case. read-only maxLength: 32
businessObjectUri	string(uri) The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/). read-only format: uri maxLength: 2048
type	caseType The type of case this is. enum values: accountApplicationReview, accountCoOwnerEnrollmentReview, authorizedSignerReview, externalAccountReview, generalInquiry, transactionInquiry, transactionDispute
state	caseState The state of the case enum values: new, active, canceled, blocked, closed
_id	string The unique identifier for this case resource. This is an immutable opaque string. read-only
lastMessageAuthor	caseMessageAuthor Describes who authored the most recent message submitted to this case's message thread. This property is only present if the case has a message thread and that message thread has at least one message. read-only
createdAt	string(date-time) When this case resource was created in rfc 3339 UTC date-time format. read-only format: date-time
createdBy	string The ID of the operator or other identity who created this note. This is derived from the user authentication ID token. read-only maxLength: 48
updatedAt	string(date-time) The RFC 3339 UTC date-time when the message was last updated or a note was added. read-only format: date-time
updatedBy	string The ID of the operator or other identity who last updated this case or added a note. This is derived from the user authentication ID token. read-only maxLength: 48

caseEmbeddedObjects

{
  "businessObject": {
    "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.6.0/profile.json",
    "accountApproval": {},
    "accountName": "My Premiere Savings",
    "applicantName": "Elsa Snowqueen",
    "applicants": [],
    "consents": [],
    "createdAt": "2018-12-13T11:01:41.375Z",
    "documents": [],
    "fundingAccount": {
      "title": "Elsa Snowqueen",
      "accountNumbers": {
        "full": "9876543210",
        "masked": "*************3210"
      },
      "institutionName": "3rd Party Bank",
      "routingNumber": "021000021"
    },
    "fundingAmount": {
      "currency": "USD",
      "value": "1500.00"
    },
    "organization": {},
    "productName": "Premiere Savings",
    "products": [],
    "state": "running",
    "workflowState": "running"
  },
  "notes": [
    {
      "_id": "c04bab3e-8767-4839",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/c04bab3e-8767-4839"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-03-31T10:08:49.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Waiting on Walter"
    },
    {
      "_id": "d62c0701-0d74",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/d62c0701-0d74"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-04-01T10:09:19.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Unassigned this case as I'm going on PTO"
    }
  ],
  "messageThread": {
    "_id": "0b886295-0ff7-420f",
    "topicName": "applicationReview",
    "contextUri": "https://api.devbank.apiture.com/accountApplications/applications/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
    "contextType": "accountApplication",
    "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
    "operatorSignature": "Mark S.",
    "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
    "subject": "Bad drivers license image",
    "unreadOperatorMessageCount": 1,
    "unreadCustomerMessageCount": 0,
    "createdAt": "2021-02-17T13:04:05.375Z",
    "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
      },
      "apiture:messages": {
        "href": "https://api.devbank.apiture.com/messages/messages?messageThread=0b886295-0ff7-420f"
      },
      "apiture:reply": {
        "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
      },
      "apiture:close": {
        "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
      }
    },
    "_embedded": {}
  }
}

Case Embedded Objects (v1.1.2)

Objects embedded in a case object.

Properties

Name	Description
Case Embedded Objects (v1.1.2)	object Objects embedded in a case object.
businessObject	object The primary business object that this case associated with, as indicated by the businessObjectUri in the case.
notes	caseNotes Notes that operators have added to the case.
messageThread	messageThread A secure message thread for communication between the operator(s) and banking customer.

caseMessageAuthor

{
  "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
  "name": "William Carlson",
  "type": "operator",
  "postedAt": "2021-10-18T12:44:13.375Z"
}

Case Message Author (v1.0.0)

Describes who authored the most recent message submitted to this case's message thread.

Properties

Name	Description
Case Message Author (v1.0.0)	object Describes who authored the most recent message submitted to this case's message thread.
_id	string (required) The resource ID of the customer or operator who submitted the last message. minLength: 16 maxLength: 48
type	messageAuthorType (required) Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator or systemAdministrator, then the recipient is the customer. messageAuthorType strings may have one of the following enumerated values: Value Description customer Customer: This message was written by the customer. operator Operator: This message was written by a financial institution operator. systemAdministrator System Administrator: This message was written by a system administrator. This schema was resolved from messages/messageAuthorType. enum values: customer, operator, systemAdministrator
name	string (required) The name of the customer or operator. maxLength: 80
postedAt	string(date-time) (required) The date-time the message was posted in in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format. format: date-time

caseNote

{
  "_profile": "https://production.api.apiture.com/schemas/cases/caseNote/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
    }
  },
  "_id": "0399abed-fd3d",
  "createdAt": "2021-03-31T10:18:44.375Z",
  "createdBy": "aea1b29f-cd66",
  "text": "waiting on Walter",
  "_embedded": {}
}

Case Note (v1.0.2)

Representation of a text note added to a case.

Properties

Name	Description
Case Note (v1.0.2)	object Representation of a text note added to a case.
_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
text	string(markdown) The text of the note. format: markdown maxLength: 400
_id	string The unique identifier for this case note resource. This is an immutable opaque string. The ID is only unique within the containing case. read-only
createdAt	string(date-time) The date-time the note was created, in rfc 3339 UTC date-time format. format: date-time
createdBy	string The ID of the operator or other identity who created this note. This is derived from the user authentication ID token. maxLength: 48

caseNotes

{
  "_profile": "https://production.api.apiture.com/schemas/cases/caseNotes/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "items": [
    {
      "_id": "0399abed-fd3d",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/6b8be842-d8de/notes/0399abed-fd3d"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-03-31T10:08:49.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Waiting on Walter"
    },
    {
      "_id": "d62c0701-0d74",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/cases/6b8be842-d8de/notes/d62c0701-0d74"
        }
      },
      "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
      "createdAt": "2021-04-01T10:09:19.375Z",
      "createdBy": "244bfbd9-5a06-13f4e2f6b93e",
      "text": "Unassigned this case as I'm going on PTO"
    }
  ]
}

Case Notes (v1.0.2)

A list of case notes. The notes are in chronological order, oldest to newest.

Properties

Name	Description
Case Notes (v1.0.2)	object A list of case notes. The notes are in chronological order, oldest to newest.
_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
items	array: [summaryCaseNote] An array containing case note items. items: object

caseState

"new"

Case State (v2.0.0)

The discrete states that a case can have.

caseState strings may have one of the following enumerated values:

Value	Description
new	New: A new case that is unassigned and not yet active.
active	In Progress: A case that is assigned and/or actively being worked on.
blocked	Blocked: A case that is blocked and unable to be completed due to some other external circumstance. (Note: a future release will provide an operation to put a case into the blocked state.)
canceled	Canceled: A case that is no longer needed and does not have to be completed.
closed	Closed: A case that the operator has closed.

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

type: string

enum values: new, active, canceled, blocked, closed

caseType

"accountApplicationReview"

Case Type (v1.0.0)

Indicates what type of cases this is.

caseType strings may have one of the following enumerated values:

Value	Description
accountApplicationReview	Account Application Review
accountCoOwnerEnrollmentReview	Account Co-owner Enrollment Review
authorizedSignerReview	Authorized Signer Review
externalAccountReview	External Account Review
generalInquiry	General Inquiry
transactionInquiry	Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry.
transactionDispute	Transaction Dispute: A customer has disputed a transaction.

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

type: string

enum values: accountApplicationReview, accountCoOwnerEnrollmentReview, authorizedSignerReview, externalAccountReview, generalInquiry, transactionInquiry, transactionDispute

cases

{
  "_profile": "https://production.api.apiture.com/schemas/cases/cases/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=10&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/cases/cases"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/cases/cases?start=20&limit=10"
    }
  },
  "name": "cases",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d",
        "number": 76908,
        "_profile": "https://production.api.apiture.com/schemas/cases/summaryCase/v2.0.0/profile.json",
        "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
        "type": "accountApplicationReview",
        "state": "active",
        "assignee": "f7a9ece0-364e",
        "assigneeFirstName": "William",
        "assigneeLastName": "Carlson",
        "userFirstName": "Elsa",
        "userLastName": "Snowqueen",
        "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
        "lastMessageAuthor": {
          "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
          "name": "William Carlson",
          "type": "operator",
          "createdAt": "2021-10-18T12:44:13.375Z"
        },
        "_links": {
          "apiture:assignee": {
            "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e"
          },
          "apiture:user": {
            "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
          },
          "self": {
            "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
          }
        }
      }
    ]
  },
  "count": 1,
  "limit": 10,
  "start": 10
}

Case Collection (v2.0.0)

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

Links

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

Rel	Summary	Method
self	Repeat the same parameterized collection query.	GET
next	Get the next page of results	GET
prev	Get the previous page of results	GET
collection	Get the first page of the unfiltered, unsorted collection	GET

Properties

Name	Description
Case Collection (v2.0.0)	object Collection of cases. The items in the collection are ordered in the _embedded.items array; the name is cases. The top-level _links object may contain pagination links (self, next, prev, first, last, collection). Links Response and request bodies using this cases schema may contain the following links: Rel Summary Method self Repeat the same parameterized collection query. GET next Get the next page of results GET prev Get the previous page of results GET collection Get the first page of the unfiltered, unsorted collection GET
_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: [summaryCase] An array containing a page of case 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.

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.

createCase

{
  "_profile": "https://production.api.apiture.com/schemas/cases/createCase/v1.2.1/profile.json",
  "_links": {
    "apiture:messageThread": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0b886295-0ff7-420f"
    }
  },
  "type": "generalInquiry",
  "assignee": "f7a9ece0-364e"
}

Create Case (v1.2.1)

Representation used to create a new case. If you wish to associate an existing message thread with the case, pass it in the apiture:messageThread link.

Links

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

Rel	Summary	Method
apiture:messageThread	A secure message thread for communicating with the banking customer	GET

Properties

Name	Description
Create Case (v1.2.1)	object Representation used to create a new case. If you wish to associate an existing message thread with the case, pass it in the apiture:messageThread link. Links Response and request bodies using this createCase schema may contain the following links: Rel Summary Method apiture:messageThread A secure message thread for communicating with the banking customer GET
_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
assignee	string The ID of the operator or other identity assigned to this case, if any. maxLength: 48
userId	string The the _id of a user in the Users API; this case is associated with the named user. The default is the User ID of the authenticated user. Operators may set set this to the _id of any valid user. maxLength: 48
businessObjectUri	string(uri) The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/). format: uri maxLength: 2048
type	caseType (required) The type of case this is. enum values: accountApplicationReview, accountCoOwnerEnrollmentReview, authorizedSignerReview, externalAccountReview, generalInquiry, transactionInquiry, transactionDispute

createCaseNote

{
  "_profile": "https://production.api.apiture.com/schemas/cases/createCaseNote/v1.0.2/profile.json",
  "_links": {},
  "text": "Waiting on Walter"
}

Create Case Note (v1.0.2)

Representation used to create a new case note.

Properties

Name	Description
Create Case Note (v1.0.2)	object Representation used to create a new case note.
_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
text	string(markdown) (required) The text of the note. format: markdown maxLength: 400

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

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.

messageAuthorType

"customer"

Message Author Type (v1.1.0)

Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator or systemAdministrator, then the recipient is the customer.

messageAuthorType strings may have one of the following enumerated values:

Value	Description
customer	Customer: This message was written by the customer.
operator	Operator: This message was written by a financial institution operator.
systemAdministrator	System Administrator: This message was written by a system administrator.

This schema was resolved from messages/messageAuthorType.

type: string

enum values: customer, operator, systemAdministrator

messageThread

{
  "_profile": "https://production.api.apiture.com/schemas/messages/messageThread/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d"
    },
    "apiture:messages": {
      "href": "https://api.devbank.apiture.com/messages/message?messageThread=0399abed-fd3d"
    },
    "apiture:reply": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/0399abed-fd3d/replies"
    },
    "apiture:close": {
      "href": "https://api.devbank.apiture.com/messages/closedMessageThreads?messageThread=0399abed-fd3d"
    }
  },
  "topicName": "cardServices",
  "contextUri": "https://api.devbank.apiture.com/cards/cards/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
  "contextType": "card",
  "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
  "operatorSignature": "Mark S.",
  "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
  "subject": "Please unlock my debit card",
  "_id": "0399abed-fd3d",
  "unreadOperatorMessageCount": 1,
  "unreadCustomerMessageCount": 0,
  "createdAt": "2021-02-17T13:04:05.375Z",
  "_embedded": {}
}

Message Thread (v1.1.1)

Representation of a message thread resource.

Links

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

Rel	Summary	Method
self	Fetch a representation of this message thread	GET
apiture:messages	Return a collection of messages	GET
apiture:reply	Create a new message in this thread.	POST
apiture:open	Open a message thread	POST
apiture:close	Close a message thread	POST

This schema was resolved from messages/messageThread.

Properties

Name	Description
Message Thread (v1.1.1)	object Representation of a message thread resource. Links Response and request bodies using this messageThread schema may contain the following links: Rel Summary Method self Fetch a representation of this message thread GET apiture:messages Return a collection of messages GET apiture:reply Create a new message in this thread. POST apiture:open Open a message thread POST apiture:close Close a message thread POST This schema was resolved from messages/messageThread.
_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
topicName	string The name of this thread's topic. This must be the name of one of the topics from getMessageTopics. minLength: 4 maxLength: 24 pattern: "^[a-z][a-zA-Z0-9]{3,23}$"
contextUri	string(uri) The optional URI of a resource that this thread pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/) format: uri maxLength: 2048
contextType	string An identifier which indicates the type of resource referenced by the contextUri. maxLength: 40 pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
applicationPlatform	applicationPlatform An optional name of the client application platform. The client should set this when creating a message with the topicName of technicalAssistance or inquiry. enum values: web, android, ios
subject	string An optional subject (title) for this thread. maxLength: 80
assignedOperator	string The ID of an financial institution operator that this thread is assigned to. This is set via the assignMessageThread operation minLength: 4 maxLength: 48
userId	string The _id of the user (Users API) associated with this thread. This is inferred when a customer user creates a message thread. A financial institution operator can set this to start a new message thread for a specific customer user. minLength: 16 maxLength: 48
_id	string The unique identifier for this message thread resource. This is an immutable opaque string. read-only
state	messageThreadState The open/closed state of the thread. This is changed by the openMessageThread or closeMessageThread operations. read-only enum values: open, closed
unreadOperatorMessageCount	integer The number of unread messages sent by an operator. This is changed when the operator reads a unread message sent to the operator or marks a read message as unread. read-only minimum: 0 maximum: 100
unreadCustomerMessageCount	integer The number of unread messages sent by the customer. This is changed when the customer reads a unread message sent to the customer or marks a read message as unread. read-only minimum: 0 maximum: 100
createdAt	string(date-time) The RFC 3339 UTC date-time when the message was created. read-only format: date-time

messageThreadState

"open"

Message Thread State (v1.0.0)

The state of the entire message thread.

messageThreadState strings may have one of the following enumerated values:

Value	Description
open	Open: An active message thread. The customer normally only views open threads in their message user experience.
closed	Closed: An message that the customer or the financial institution has closed. The financial institution can reopen closed threads.

This schema was resolved from messages/messageThreadState.

type: string

enum values: open, closed

productTarget

"personal"

Product Target (v1.0.0)

The target audience for this product.

productTarget strings may have one of the following enumerated values:

Value	Description
personal	Banking products for personal use
business	Banking products for business use

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

This schema was resolved from products/productTarget.

type: string

enum values: personal, business

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.

summaryCase

{
  "_profile": "https://production.api.apiture.com/schemas/cases/summaryCase/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/cases/0399abed-fd3d"
    },
    "apiture:assignee": {
      "href": "https://api.devbank.apiture.com/operators/operators/f7a9ece0-364e"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/9bfae024-b835-4fb8-88f7-5d01d2d57382"
    }
  },
  "number": 76908,
  "type": "accountApplicationReview",
  "assignee": "f7a9ece0-364e",
  "assigneeFirstName": "William",
  "assigneeLastName": "Carlson",
  "userFirstName": "Elsa",
  "userLastName": "Snowqueen",
  "userId": "9bfae024-b835-4fb8-88f7-5d01d2d57382",
  "state": "active",
  "businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630",
  "_id": "0399abed-fd3d",
  "lastMessageAuthor": {
    "_id": "db7bde2f-f1f9-42b8-ad1b-347e5c167d42",
    "name": "William Carlson",
    "type": "operator",
    "postedAt": "2021-10-18T12:44:13.375Z"
  }
}

Case Summary (v2.0.0)

Summary representation of a case resource in the cases collection. This representation normally does not contain any _embedded objects.

Links

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

Rel	Summary	Method
self	Fetch a representation of this case	GET
apiture:user	The case's banking user	GET
apiture:assignee	The operator or other identity assigned to this case	GET
apiture:assignCaseToMe	Assign a case to the caller	POST
apiture:unassign	Remove the operator assignment	POST
apiture:cancel	Cancel a case	POST
apiture:close	Mark a case as closed	POST
apiture:businessObject	Related Business Object	GET
apiture:messageThread	A secure message thread for communicating with the banking customer	GET

Properties

Name	Description
Case Summary (v2.0.0)	object Summary representation of a case resource in the cases collection. This representation normally does not contain any _embedded objects. Links Response and request bodies using this summaryCase schema may contain the following links: Rel Summary Method self Fetch a representation of this case GET apiture:user The case's banking user GET apiture:assignee The operator or other identity assigned to this case GET apiture:assignCaseToMe Assign a case to the caller POST apiture:unassign Remove the operator assignment POST apiture:cancel Cancel a case POST apiture:close Mark a case as closed POST apiture:businessObject Related Business Object GET apiture:messageThread A secure message thread for communicating with the banking customer GET
_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
number	integer This case's sequential number, for easy reference. minimum: 0
userFirstName	string The first name of the banking customer user that this case is for. read-only
userLastName	string The first name of the banking customer user that this case is for. read-only
userId	string The _id of the user (bank customer) associated with this case, from the Users API. This is the userId passed to the createCase operation. read-only maxLength: 48
assignee	string The ID of the operator or other identity assigned to this case, if any. This is immutable in a case (no PUT update), but an operator may change this via the assignCaseToMe operation. read-only maxLength: 48
assigneeFirstName	string The first name of the operator or other identity assigned to this case, if any. This is derived from the access token used when the case is assigned or from the assignee ID passed when creating a case. read-only maxLength: 32
assigneeLastName	string The last name of the operator or other identity assigned to this case, if any. This is derived from the access token used when the case is assigned or from the assignee ID passed when creating a case. read-only maxLength: 32
businessObjectUri	string(uri) The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/). read-only format: uri maxLength: 2048
type	caseType The type of case this is. enum values: accountApplicationReview, accountCoOwnerEnrollmentReview, authorizedSignerReview, externalAccountReview, generalInquiry, transactionInquiry, transactionDispute
state	caseState The state of the case enum values: new, active, canceled, blocked, closed
_id	string The unique identifier for this case resource. This is an immutable opaque string. read-only
lastMessageAuthor	caseMessageAuthor Describes who authored the most recent message submitted to this case's message thread. This property is only present if the case has a message thread and that message thread has at least one message. read-only
createdAt	string(date-time) When this case resource was created in rfc 3339 UTC date-time format. read-only format: date-time
createdBy	string The ID of the operator or other identity who created this note. This is derived from the user authentication ID token. read-only maxLength: 48
updatedAt	string(date-time) The RFC 3339 UTC date-time when the message was last updated or a note was added. read-only format: date-time
updatedBy	string The ID of the operator or other identity who last updated this case or added a note. This is derived from the user authentication ID token. read-only maxLength: 48

summaryCaseNote

{
  "_profile": "https://production.api.apiture.com/schemas/cases/summaryCaseNote/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/cases/0399abed-fd3d/notes/0399abed-fd3d"
    }
  },
  "_id": "0399abed-fd3d",
  "createdAt": "2021-03-31T10:18:44.375Z",
  "createdBy": "aea1b29f-cd66",
  "text": "Waiting on Walter"
}

Case Note Summary (v1.0.2)

Summary representation of a case note resource in case notes 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
Case Note Summary (v1.0.2)	object Summary representation of a case note resource in case notes 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
text	string(markdown) The text of the note. format: markdown maxLength: 400
_id	string The unique identifier for this case note resource. This is an immutable opaque string. The ID is only unique within the containing case. read-only
createdAt	string(date-time) The date-time the note was created, in rfc 3339 UTC date-time format. format: date-time
createdBy	string The ID of the operator or other identity who created this note. This is derived from the user authentication ID token. maxLength: 48

summaryMessageThread

{
  "_profile": "https://production.api.apiture.com/schemas/messages/summaryMessageThread/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/messages/messageThreads/b171c313-0264"
    }
  },
  "topicName": "cardServices",
  "contextUri": "https://api.devbank.apiture.com/cards/cards/2c4b530a-ecea-4d7b-a543-9a4995869a2e",
  "contextType": "card",
  "userId": "674ae8f4-097e-4a45-85a0-a331ce7be2da",
  "operatorSignature": "Mark S.",
  "assignedOperator": "95c943aa-bd7f-4ae0-a8f9-42ba3b4feb5d",
  "subject": "Please unlock my debit card",
  "_id": "b171c313-0264",
  "unreadOperatorMessageCount": 1,
  "unreadCustomerMessageCount": 0,
  "createdAt": "2021-02-17T13:04:05.375Z"
}

Message Thread Summary (v1.1.1)

Summary representation of a message thread resource in message threads 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.

This schema was resolved from messages/summaryMessageThread.

Properties

Name	Description
Message Thread Summary (v1.1.1)	object Summary representation of a message thread resource in message threads 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. This schema was resolved from messages/summaryMessageThread.
_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
topicName	string The name of this thread's topic. This must be the name of one of the topics from getMessageTopics. minLength: 4 maxLength: 24 pattern: "^[a-z][a-zA-Z0-9]{3,23}$"
contextUri	string(uri) The optional URI of a resource that this thread pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/) format: uri maxLength: 2048
contextType	string An identifier which indicates the type of resource referenced by the contextUri. maxLength: 40 pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
applicationPlatform	applicationPlatform An optional name of the client application platform. The client should set this when creating a message with the topicName of technicalAssistance or inquiry. enum values: web, android, ios
subject	string An optional subject (title) for this thread. maxLength: 80
assignedOperator	string The ID of an financial institution operator that this thread is assigned to. This is set via the assignMessageThread operation minLength: 4 maxLength: 48
userId	string The _id of the user (Users API) associated with this thread. This is inferred when a customer user creates a message thread. A financial institution operator can set this to start a new message thread for a specific customer user. minLength: 16 maxLength: 48
_id	string The unique identifier for this message thread resource. This is an immutable opaque string. read-only
state	messageThreadState The open/closed state of the thread. This is changed by the openMessageThread or closeMessageThread operations. read-only enum values: open, closed
unreadOperatorMessageCount	integer The number of unread messages sent by an operator. This is changed when the operator reads a unread message sent to the operator or marks a read message as unread. read-only minimum: 0 maximum: 100
unreadCustomerMessageCount	integer The number of unread messages sent by the customer. This is changed when the customer reads a unread message sent to the customer or marks a read message as unread. read-only minimum: 0 maximum: 100
createdAt	string(date-time) The RFC 3339 UTC date-time when the message was created. read-only format: date-time

---