Admin Analyst Notificiation v0.2.0

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

Admin analyst notifications are a collection of informative messages for the user within financial analytics. They can represent references to when a user has been added as a collaborator through having a resource shared with them, or when that access is revoked, as well as system generated alerts when thresholds are crossed.

Notifications have different states to represent how they have been interacted with. A notification that is viewed means it has been presented to the user in the list of new notifications, whereas read means the user has specifically opened that notification. Notifications that are read are automatically viewed.

The system will automatically remove notifications 30 days after they are created. A client may also explicitly delete analyst notifications.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

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

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Analyst Notifications

Analyst Notifications

listAnalystNotifications

Code samples

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

GET https://api.apiture.com/bankingAdmin/analystNotifications HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/analystNotifications',
{
  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}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/analystNotifications',
  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}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Fetch a representation of the analyst notifications

GET https://api.apiture.com/bankingAdmin/analystNotifications

Return the collection of analyst notification resources for the analyst identified in the access token.

Example responses

200 Response

{
  "unreadCount": 1,
  "unviewedCount": 0,
  "items": [
    {
      "id": "0399abed-fd3d",
      "message": "Insight 'FDIC Deposit Overage Account Holders' has been shared with you",
      "resource_url": "https://production.api.apiture.com/bankingAdmin/analytics/insights/09220fdb-2112",
      "type": "insight",
      "action": "shared",
      "read": true,
      "viewed": true,
      "agent": {
        "id": "d62c0701-0d74",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      },
      "viewedAt": "2023-05-12T17:32:26.000Z",
      "readAt": "2023-05-12T17:32:26.000Z",
      "createdAt": "2023-05-12T17:00:00.000Z",
      "updatedAt": "2023-05-12T17:00:00.000Z"
    },
    {
      "id": "4c92592f-e0f7",
      "message": "Access to audience 'Mortgage Prospects' has been revoked",
      "type": "audience",
      "action": "removedFromCollaborators",
      "read": false,
      "viewed": true,
      "agent": {
        "id": "d62c0701-0d74",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      },
      "viewedAt": "2023-05-12T17:32:26.000Z",
      "createdAt": "2023-05-12T17:00:00.000Z",
      "updatedAt": "2023-05-12T17:00:00.000Z"
    }
  ]
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Analyst Notification Actions

Actions on Analyst Notifications

markAnalystNotificationsAsRead

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/readAnalystNotifications',
{
  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}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/readAnalystNotifications',
  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}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Mark analyst notifications as read

POST https://api.apiture.com/bankingAdmin/readAnalystNotifications

Mark a list of analyst notifications as read. Notifications that are already marked as read are not changed.

This also marks the notifications as viewed.

Body parameter

{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
          "title": "Account Not Found",
          "status": 422,
          "occurredAt": "2022-04-25T12:42:21.375Z",
          "detail": "No account exists at the given account_url",
          "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

markAnalystNotificationsAsUnread

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/unreadAnalystNotifications',
{
  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}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/unreadAnalystNotifications',
  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}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Mark the analyst notifications as unread

POST https://api.apiture.com/bankingAdmin/unreadAnalystNotifications

Mark a list of analyst notifications as unread. Notifications that are already marked as unread are not changed.

Marking a notification as unread does not affect the value of the viewed property.

Body parameter

{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
          "title": "Account Not Found",
          "status": 422,
          "occurredAt": "2022-04-25T12:42:21.375Z",
          "detail": "No account exists at the given account_url",
          "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

markAnalystNotificationsAsViewed

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/viewedAnalystNotifications',
{
  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}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/viewedAnalystNotifications',
  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}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Mark analyst notifications as viewed

POST https://api.apiture.com/bankingAdmin/viewedAnalystNotifications

Mark a list of analyst notifications as viewed. Notifications that are already marked as viewed are not changed.

Body parameter

{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
          "title": "Account Not Found",
          "status": 422,
          "occurredAt": "2022-04-25T12:42:21.375Z",
          "detail": "No account exists at the given account_url",
          "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

deleteAnalystNotifications

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/deletedAnalystNotifications',
{
  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}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/deletedAnalystNotifications',
  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}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Delete analyst notifications

POST https://api.apiture.com/bankingAdmin/deletedAnalystNotifications

Delete a list of analyst notifications.

Body parameter

{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
          "title": "Account Not Found",
          "status": 422,
          "occurredAt": "2022-04-25T12:42:21.375Z",
          "detail": "No account exists at the given account_url",
          "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

analystNotificationAction

"shared"

Analyst Notification Action (v1.1.0)

The action which triggered the notification.

analystNotificationAction strings may have one of the following enumerated values:

type: string

enum values: shared, addedToCollaborators, removedFromCollaborators, addedToOwners, removedFromOwners, archived, restored, triggered

analystNotificationIds

[
  "09220fdb-2112",
  "4c92592f-e0f7",
  "1ff3d7d4-4ac2"
]

Analyst Notification IDs (v1.0.0)

A set of unique IDs of notification resources.

analystNotificationIds is an array schema.

Array Elements

type: array: [resourceId]

unique items
maxItems: 10000

analystNotificationItem

{
  "id": "0399abed-fd3d",
  "message": "Insight 'FDIC Deposit Overage Account Holders' has been shared with you",
  "resource_url": "https://production.api.apiture.com/bankingAdmin/analytics/insights/09220fdb-2112",
  "type": "insight",
  "action": "shared",
  "read": true,
  "viewed": true,
  "agent": {
    "id": "d62c0701-0d74",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings",
    "state": "active"
  },
  "viewedAt": "2023-05-12T17:32:26.000Z",
  "readAt": "2023-05-12T17:32:26.000Z",
  "createdAt": "2023-05-12T17:00:00.000Z",
  "updatedAt": "2023-05-12T17:00:00.000Z"
}

Analyst Notification Item (v1.1.0)

Representation of an analyst notification resource.

Properties

analystNotificationType

"insight"

Analyst Notification Type (v1.0.0)

The contextual type of the notification.

analystNotificationType strings may have one of the following enumerated values:

type: string

enum values: insight, audience, dashboard, alert

analystNotifications

{
  "unreadCount": 1,
  "unviewedCount": 0,
  "items": [
    {
      "id": "0399abed-fd3d",
      "message": "Insight 'FDIC Deposit Overage Account Holders' has been shared with you",
      "resource_url": "https://production.api.apiture.com/bankingAdmin/analytics/insights/09220fdb-2112",
      "type": "insight",
      "action": "shared",
      "read": true,
      "viewed": true,
      "agent": {
        "id": "d62c0701-0d74",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      },
      "viewedAt": "2023-05-12T17:32:26.000Z",
      "readAt": "2023-05-12T17:32:26.000Z",
      "createdAt": "2023-05-12T17:00:00.000Z",
      "updatedAt": "2023-05-12T17:00:00.000Z"
    },
    {
      "id": "4c92592f-e0f7",
      "message": "Access to audience 'Mortgage Prospects' has been revoked",
      "type": "audience",
      "action": "removedFromCollaborators",
      "read": false,
      "viewed": true,
      "agent": {
        "id": "d62c0701-0d74",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      },
      "viewedAt": "2023-05-12T17:32:26.000Z",
      "createdAt": "2023-05-12T17:00:00.000Z",
      "updatedAt": "2023-05-12T17:00:00.000Z"
    }
  ]
}

Analyst Notifications (v1.1.0)

Collection of notifications for an analyst. The items in the collection are ordered in the items array.

Properties

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

bulkAnalystNotificationOperationResponse

{
  "items": [
    {
      "id": "string",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
          "title": "Account Not Found",
          "status": 422,
          "occurredAt": "2022-04-25T12:42:21.375Z",
          "detail": "No account exists at the given account_url",
          "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Bulk Analyst Notification Operation (v1.0.0)

Bulk analyst notification operation response.

Properties

bulkAnalystNotificationOperationResponseItem

{
  "id": "string",
  "succeeded": true,
  "problems": [
    {
      "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
      "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
      "title": "Account Not Found",
      "status": 422,
      "occurredAt": "2022-04-25T12:42:21.375Z",
      "detail": "No account exists at the given account_url",
      "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
    }
  ]
}

Bulk Notification Operation Item (v1.0.0)

An item in a bulk notification operation response.

Properties

bulkAnalystNotificationsRequest

{
  "notificationIds": [
    "09220fdb-2112",
    "4c92592f-e0f7",
    "1ff3d7d4-4ac2"
  ]
}

Bulk Analyst Notifications Request (v1.0.0)

A request to perform the operation on a set of notifications.

Properties

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

customerUsername

"string"

Customer Username (v1.0.0)

A customer's login username.

type: string(text)

format: text
maxLength: 20

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

userAccountReference

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings"
}

User Account Reference (v1.0.2)

The representation of a user account.

Properties