Audit v0.3.0

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

The Audit API provides read-only access to Apiture system audit records, which track user online banking activity. This API is available to administrators only, not bank customers. Only activity processed by Apiture APIs and services is available through this API.

This API manages two primary resources: audit records of user or other activity, and audit record types which are metadata that describe the data in the audit records.

Each audit record contains the type of the record, the user who performed the activity, the URI of related resources, a time stamp, and a data object containing type-specific properties of the activity; see the record schema below. Administrator users of this API can filter audit records using most of these values.

The content of each audit record is defined with an audit record type which describes the content of all audit records of that type. The audit record type contains its name, label, description and a JSON schema object which defines the data types and descriptions of the data property of an audit record. See the recordType schema below.

There is a many-to-one relationship between audit records and audit record types.

Audit record queries

The getAuditRecords operation supports querying by the fields common to all audit records: ?type=, ?category=, ?user=, ?host=, ?uri=, (To filter by date/time, see Time-bound queries below.)

Audit records by user

Each audit record contains the customerId of the user who performed the auditable action, if it is known. The customerId is the unique customerId of the user's resource from the Users service. This indicates who performed the audited activity. In some cases, administrators at the financial institution can perform some actions on behalf of users from an administrative application. If this occurs, the audit record's customerId will be the ID of the administrator, and the onBehalfOf value will be the customer ID of the financial institution customer. The ?user={customerId} query parameter on getAuditRecords matches either the customerId property or the onBehalfOf property.

The customer ID is not always known. For example, if an administrator reverses a transaction in the core servicing application and that reversal flows into Apiture resources, Apiture may not be able to attribute the activity to a user, but will still create an audit record for the activity. The customerId has the value <system> for audit records for such operations. Please consult the audit records in the banking core or servicing application to track such activity.

Time-bound queries

The audit record views also support time-bounded queries. By default, the getAuditRecords and getAuditRecordsByType operations return records for the current day (based on the date component of the record's occurredAt field), in reverse chronological order.

These date-time bounds can be passed explicitly to override the defaults:

1. Pass the startAt and endAt to find any records which overlap that date range. For example, to fetch for the first six days of September 2019, request ?startAt=2019-09-01&period=P6D.
2. Pass the startAt to find audit records beginning at that date or date-time. The optional period determines how many minutes, hours, or days of data to include in the paginated response.
3. Pass the endAt to return audit records which occurred up to specified date or date time. The optional period determines how many minutes, hours, or days of data to include in the paginated response. For example, to fetch for the last six days of September 2019, request ?startAt=2019-09-30&period=P6D.

The default period is P1D. To fetch records for the last six days, request just ?period=P6D; use ?period=PT1H to select just the past one hour of data. This result list of records is sorted in reverse chronological order unless startAt is specified. (The default endAt is the current instant.) period is not allowed if both startAt and endAt are passed.

To find transfers scheduled in September 2019, specify a startAt of September 1 and a period of P1M (one month):

GET /audit/recordsByType?type=transferScheduled&startAt=2019-09-01&period=P1M

startAt and endAt may be either specific date or date-time values in RFC 3339 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.sssZ). Caution: The occurredAt time is in UTC time zone; adjust start and end times to account for local time zones.

Download OpenAPI Definition (YAML)

Base URLs:

• /audit

Terms of service

Email: Apiture Web: Apiture

Authentication

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

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

Audit Record

Audit Record

getAuditRecords

Code samples

# You can also use wget
curl -X GET /audit/records \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /audit/records HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/audit/records',
  method: 'get',

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

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

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

};

fetch('/audit/records',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/records',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/records', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/audit/records", data)
    req.Header = headers

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

Return audit records

GET /records

Return a paginated sortable collection of audit records which satisfy the filtering query parameters. By default, this returns records for the past 24 hours, in reverse chronological order. This result list of records is sorted in reverse chronological order unless ?startAt= is specified. The links in the response include pagination links.

Parameters

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/audit/records/v1.0.0/profile.json",
  "start": 0,
  "limit": 1000,
  "count": 1000,
  "name": "records",
  "_links": {
    "self": {
      "href": "/audit/records?category=transfers"
    },
    "next": {
      "href": "/audit/records?category=transfers&start=1000&limit=1000"
    },
    "collection": {
      "href": "/audit/records"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/audit/record/v1.0.0/profile.json",
        "type": "transferScheduled",
        "occurredAt": {},
        "username": "lucy.wellphunded@bankcustomer.example.com",
        "host": "13.226.38.34",
        "primaryUri": "/transfers/scheduledTransfer/a727ff2a-08ea-42ce-b8dc-edea60646819",
        "data": {
          "sourceAccount": "9876543210",
          "sourceRoutingNumber": "021000021",
          "targetAccount": "9876543219",
          "targetRoutingNumber": "021000021",
          "amount": "1500.00",
          "currency": "USD",
          "start": {}
        },
        "links": {
          "self": {
            "href": "/audit/records/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:type": {
            "href": "/audit/types/transferScheduled"
          }
        }
      }
    ]
  }
}

Responses

getAuditRecord

Code samples

# You can also use wget
curl -X GET /audit/records/{recordId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /audit/records/{recordId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: '/audit/records/{recordId}',
  method: 'get',

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

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

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

};

fetch('/audit/records/{recordId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/records/{recordId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/records/{recordId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/audit/records/{recordId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/audit/records/{recordId}", data)
    req.Header = headers

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

Fetch a representation of this audit record

GET /records/{recordId}

Return a HAL representation of this audit record resource.

Parameters

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/audit/record/v1.0.0/profile.json",
  "type": "transferScheduled",
  "occurredAt": {},
  "customerId": "32bc88e4003d061f4fdb",
  "username": "lucy.wellphunded@bankcustomer.example.com",
  "host": "13.226.38.34",
  "primaryUri": "/transfers/scheduledTransfer/a727ff2a-08ea-42ce-b8dc-edea60646819",
  "data": {
    "sourceAccount": "9876543210",
    "sourceRoutingNumber": "021000021",
    "targetAccount": "9876543219",
    "targetRoutingNumber": "021000021",
    "amount": "1500.00",
    "currency": "USD",
    "start": {}
  },
  "links": {
    "self": {
      "href": "/audit/records/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:type": {
      "href": "/audit/types/transferScheduled"
    }
  }
}

Responses

Response Headers

Audit Record Type

Audit Record Types

getAuditRecordTypes

Code samples

# You can also use wget
curl -X GET /audit/types \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /audit/types HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/audit/types',
  method: 'get',

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

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

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

};

fetch('/audit/types',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/types',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/types', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/audit/types", data)
    req.Header = headers

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

Return a collection of audit record types

GET /types

Return a collection of audit record types.

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/audit/recordTypes/v1.0.0/profile.json",
  "start": 0,
  "count": 67,
  "name": "recordTypes",
  "_links": {
    "self": {
      "href": "/audit/recordTypes?start=10&limit=10"
    },
    "collection": {
      "href": "/audit/recordTypes"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "transferScheduled",
        "_profile": "https://api.apiture.com/schemas/audit/recordType/v1.0.0/profile.json",
        "label": "Transfer Scheduled",
        "category": "transfers",
        "categoryLabel": "Transfers",
        "version": "1.0.0",
        "description": "The user scheduled a one-time or recurring transfer.",
        "_links": {
          "self": {
            "href": "/audit/recordTypes/transferScheduled"
          }
        },
        "schema": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "https://api.apiture.com/schemas/audit/transferScheduled/v1.0.0/schema.json",
          "x-apiture-name": "transferScheduled",
          "x-apiture-category": "transfers",
          "x-apiture-categoryLabel": "Transfers",
          "x-apiture-primaryUri": "The transfer resource",
          "x-apiture-secondaryUri": "The source account",
          "type": "object",
          "title": "Transfer Scheduled",
          "description": "The user scheduled a one-time or recurring transfer.",
          "required": [
            "sourceAccountNumber",
            "sourceRoutingNumber",
            "targetAccountNumber",
            "targetRoutingNumber",
            "amount",
            "currency",
            "start"
          ],
          "properties": {
            "sourceAccountNumber": {
              "description": "The account number where funds are withdrawn.",
              "type": "string"
            },
            "sourceRoutingNumber": {
              "description": "The routing number of the financial institution where funds are withdrawn.",
              "type": "string"
            },
            "targetAccountNumber": {
              "description": "The account number where funds are deposited.",
              "type": "string"
            },
            "targetRoutingNumber": {
              "description": "The routing number of the financial institution where funds are deposited.",
              "type": "string"
            },
            "amount": {
              "description": "The amount that was scheduled to transfer.",
              "type": "string"
            },
            "currency": {
              "description": "The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value. This is always upper case ASCII. ",
              "type": "string",
              "minLength": 3,
              "maxLength": 3
            },
            "start": {
              "description": "When the transfer occurs, or when a recurring transfer begins. \n",
              "type": "string",
              "example": "2018-06-10"
            },
            "every": {
              "description": "For recurring transfers, how often the tranfser recurs.",
              "type": "string",
              "example": "P1M"
            },
            "count": {
              "description": "For a recurring transfer, this is the number of transfers which have been processed. It is a derived value and ignored on updates.",
              "type": "integer",
              "example": 5
            },
            "first": {
              "description": "If `true`, future transfers in the series should be executed on the _first_  processing day of the month.",
              "type": "boolean",
              "example": true
            },
            "last": {
              "description": "If `true`, future transfers in the series should be executed on the _last_  processing day of the month.",
              "type": "boolean",
              "example": false
            },
            "maximumCount": {
              "description": "The maximum number of transfers to perform for a recurring transfer.",
              "type": "integer",
              "example": 10
            },
            "end": {
              "description": "Do not schedule transfers beyond this date.",
              "type": "string",
              "example": "2018-08-01"
            }
          }
        }
      }
    ]
  }
}

Responses

getAuditRecordType

Code samples

# You can also use wget
curl -X GET /audit/types/{recordTypeId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /audit/types/{recordTypeId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: '/audit/types/{recordTypeId}',
  method: 'get',

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

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

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

};

fetch('/audit/types/{recordTypeId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/types/{recordTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/types/{recordTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/audit/types/{recordTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/audit/types/{recordTypeId}", data)
    req.Header = headers

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

Fetch a representation of this audit record type

GET /types/{recordTypeId}

Return a HAL representation of this audit record type resource.

Parameters

Example responses

200 Response

{
  "name": "transferScheduled",
  "_profile": "https://api.apiture.com/schemas/audit/recordType/v1.0.0/profile.json",
  "label": "Transfer Scheduled",
  "category": "transfers",
  "categoryLabel": "Transfers",
  "version": "1.0.0",
  "description": "The user scheduled a one-time or recurring transfer.",
  "_links": {
    "self": {
      "href": "/audit/recordTypes/transferScheduled"
    }
  },
  "schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "https://api.apiture.com/schemas/audit/transferScheduled/v1.0.0/schema.json",
    "x-apiture-name": "transferScheduled",
    "x-apiture-category": "transfers",
    "x-apiture-categoryLabel": "Transfers",
    "x-apiture-primaryUri": "The transfer resource",
    "x-apiture-secondaryUri": "The source account",
    "type": "object",
    "title": "Transfer Scheduled",
    "description": "The user scheduled a one-time or recurring transfer.",
    "required": [
      "sourceAccountNumber",
      "sourceRoutingNumber",
      "targetAccountNumber",
      "targetRoutingNumber",
      "amount",
      "currency",
      "start"
    ],
    "properties": {
      "sourceAccountNumber": {
        "description": "The account number where funds are withdrawn.",
        "type": "string"
      },
      "sourceRoutingNumber": {
        "description": "The routing number of the financial institution where funds are withdrawn.",
        "type": "string"
      },
      "targetAccountNumber": {
        "description": "The account number where funds are deposited.",
        "type": "string"
      },
      "targetRoutingNumber": {
        "description": "The routing number of the financial institution where funds are deposited.",
        "type": "string"
      },
      "amount": {
        "description": "The amount that was scheduled to transfer.",
        "type": "string"
      },
      "currency": {
        "description": "The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value. This is always upper case ASCII. ",
        "type": "string",
        "minLength": 3,
        "maxLength": 3
      },
      "start": {
        "description": "When the transfer occurs, or when a recurring transfer begins. \n",
        "type": "string",
        "example": "2018-06-10"
      },
      "every": {
        "description": "For recurring transfers, how often the tranfser recurs.",
        "type": "string",
        "example": "P1M"
      },
      "count": {
        "description": "For a recurring transfer, this is the number of transfers which have been processed. It is a derived value and ignored on updates.",
        "type": "integer",
        "example": 5
      },
      "first": {
        "description": "If `true`, future transfers in the series should be executed on the _first_  processing day of the month.",
        "type": "boolean",
        "example": true
      },
      "last": {
        "description": "If `true`, future transfers in the series should be executed on the _last_  processing day of the month.",
        "type": "boolean",
        "example": false
      },
      "maximumCount": {
        "description": "The maximum number of transfers to perform for a recurring transfer.",
        "type": "integer",
        "example": 10
      },
      "end": {
        "description": "Do not schedule transfers beyond this date.",
        "type": "string",
        "example": "2018-08-01"
      }
    }
  }
}

Responses

Response Headers

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /audit/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET /audit/ HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/audit/',
  method: 'get',

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

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

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

};

fetch('/audit/',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/audit/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

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

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /audit/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /audit/apiDoc HTTP/1.1

Accept: application/json

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

};

$.ajax({
  url: '/audit/apiDoc',
  method: 'get',

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

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

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

};

fetch('/audit/apiDoc',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/audit/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/audit/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/audit/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", "/audit/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Schemas

recordType

{
  "name": "transferScheduled",
  "_profile": "https://api.apiture.com/schemas/audit/recordType/v1.0.0/profile.json",
  "label": "Transfer Scheduled",
  "category": "transfers",
  "categoryLabel": "Transfers",
  "version": "1.0.0",
  "description": "The user scheduled a one-time or recurring transfer.",
  "_links": {
    "self": {
      "href": "/audit/recordTypes/transferScheduled"
    }
  },
  "schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "https://api.apiture.com/schemas/audit/transferScheduled/v1.0.0/schema.json",
    "x-apiture-name": "transferScheduled",
    "x-apiture-category": "transfers",
    "x-apiture-categoryLabel": "Transfers",
    "x-apiture-primaryUri": "The transfer resource",
    "x-apiture-secondaryUri": "The source account",
    "type": "object",
    "title": "Transfer Scheduled",
    "description": "The user scheduled a one-time or recurring transfer.",
    "required": [
      "sourceAccountNumber",
      "sourceRoutingNumber",
      "targetAccountNumber",
      "targetRoutingNumber",
      "amount",
      "currency",
      "start"
    ],
    "properties": {
      "sourceAccountNumber": {
        "description": "The account number where funds are withdrawn.",
        "type": "string"
      },
      "sourceRoutingNumber": {
        "description": "The routing number of the financial institution where funds are withdrawn.",
        "type": "string"
      },
      "targetAccountNumber": {
        "description": "The account number where funds are deposited.",
        "type": "string"
      },
      "targetRoutingNumber": {
        "description": "The routing number of the financial institution where funds are deposited.",
        "type": "string"
      },
      "amount": {
        "description": "The amount that was scheduled to transfer.",
        "type": "string"
      },
      "currency": {
        "description": "The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value. This is always upper case ASCII. ",
        "type": "string",
        "minLength": 3,
        "maxLength": 3
      },
      "start": {
        "description": "When the transfer occurs, or when a recurring transfer begins. \n",
        "type": "string",
        "example": "2018-06-10"
      },
      "every": {
        "description": "For recurring transfers, how often the tranfser recurs.",
        "type": "string",
        "example": "P1M"
      },
      "count": {
        "description": "For a recurring transfer, this is the number of transfers which have been processed. It is a derived value and ignored on updates.",
        "type": "integer",
        "example": 5
      },
      "first": {
        "description": "If `true`, future transfers in the series should be executed on the _first_  processing day of the month.",
        "type": "boolean",
        "example": true
      },
      "last": {
        "description": "If `true`, future transfers in the series should be executed on the _last_  processing day of the month.",
        "type": "boolean",
        "example": false
      },
      "maximumCount": {
        "description": "The maximum number of transfers to perform for a recurring transfer.",
        "type": "integer",
        "example": 10
      },
      "end": {
        "description": "Do not schedule transfers beyond this date.",
        "type": "string",
        "example": "2018-08-01"
      }
    }
  }
}

Audit Record Type

Representation of audit record type resources.

Properties

recordTypes

{
  "_profile": "https://api.apiture.com/schemas/audit/recordTypes/v1.0.0/profile.json",
  "start": 0,
  "count": 67,
  "name": "recordTypes",
  "_links": {
    "self": {
      "href": "/audit/recordTypes?start=10&limit=10"
    },
    "collection": {
      "href": "/audit/recordTypes"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "transferScheduled",
        "_profile": "https://api.apiture.com/schemas/audit/recordType/v1.0.0/profile.json",
        "label": "Transfer Scheduled",
        "category": "transfers",
        "categoryLabel": "Transfers",
        "version": "1.0.0",
        "description": "The user scheduled a one-time or recurring transfer.",
        "_links": {
          "self": {
            "href": "/audit/recordTypes/transferScheduled"
          }
        },
        "schema": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "https://api.apiture.com/schemas/audit/transferScheduled/v1.0.0/schema.json",
          "x-apiture-name": "transferScheduled",
          "x-apiture-category": "transfers",
          "x-apiture-categoryLabel": "Transfers",
          "x-apiture-primaryUri": "The transfer resource",
          "x-apiture-secondaryUri": "The source account",
          "type": "object",
          "title": "Transfer Scheduled",
          "description": "The user scheduled a one-time or recurring transfer.",
          "required": [
            "sourceAccountNumber",
            "sourceRoutingNumber",
            "targetAccountNumber",
            "targetRoutingNumber",
            "amount",
            "currency",
            "start"
          ],
          "properties": {
            "sourceAccountNumber": {
              "description": "The account number where funds are withdrawn.",
              "type": "string"
            },
            "sourceRoutingNumber": {
              "description": "The routing number of the financial institution where funds are withdrawn.",
              "type": "string"
            },
            "targetAccountNumber": {
              "description": "The account number where funds are deposited.",
              "type": "string"
            },
            "targetRoutingNumber": {
              "description": "The routing number of the financial institution where funds are deposited.",
              "type": "string"
            },
            "amount": {
              "description": "The amount that was scheduled to transfer.",
              "type": "string"
            },
            "currency": {
              "description": "The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value. This is always upper case ASCII. ",
              "type": "string",
              "minLength": 3,
              "maxLength": 3
            },
            "start": {
              "description": "When the transfer occurs, or when a recurring transfer begins. \n",
              "type": "string",
              "example": "2018-06-10"
            },
            "every": {
              "description": "For recurring transfers, how often the tranfser recurs.",
              "type": "string",
              "example": "P1M"
            },
            "count": {
              "description": "For a recurring transfer, this is the number of transfers which have been processed. It is a derived value and ignored on updates.",
              "type": "integer",
              "example": 5
            },
            "first": {
              "description": "If `true`, future transfers in the series should be executed on the _first_  processing day of the month.",
              "type": "boolean",
              "example": true
            },
            "last": {
              "description": "If `true`, future transfers in the series should be executed on the _last_  processing day of the month.",
              "type": "boolean",
              "example": false
            },
            "maximumCount": {
              "description": "The maximum number of transfers to perform for a recurring transfer.",
              "type": "integer",
              "example": 10
            },
            "end": {
              "description": "Do not schedule transfers beyond this date.",
              "type": "string",
              "example": "2018-08-01"
            }
          }
        }
      }
    ]
  }
}

Audit Record Type Collection

Collection of audit record types. The items in the collection are listed in the _embedded.items array; the name is recordTypes.

Properties

record

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/audit/record/v1.0.0/profile.json",
  "type": "transferScheduled",
  "occurredAt": {},
  "customerId": "32bc88e4003d061f4fdb",
  "username": "lucy.wellphunded@bankcustomer.example.com",
  "host": "13.226.38.34",
  "primaryUri": "/transfers/scheduledTransfer/a727ff2a-08ea-42ce-b8dc-edea60646819",
  "data": {
    "sourceAccount": "9876543210",
    "sourceRoutingNumber": "021000021",
    "targetAccount": "9876543219",
    "targetRoutingNumber": "021000021",
    "amount": "1500.00",
    "currency": "USD",
    "start": {}
  },
  "links": {
    "self": {
      "href": "/audit/records/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:type": {
      "href": "/audit/types/transferScheduled"
    }
  }
}

Audit Record

A data record representing an auditable banking activity or action performed by a user. This conveys:

• who did something (customerId, username, onBehalfOf),
• what they did (type, category),
• when they did it (occurredAt),
• where they did it (host),
• what they did it to (primaryUri, secondaryUri)
• additional data that is specific to the activity type.

The type is a key into the set of audit record types (see getAuditRecordType, GET /audit/recordTypes/{type}). An audit record has a link (apiture:type) to the this audit record type resource. The record type contains a JSON schema that describes the data in the record's data object.

Properties

records

{
  "_profile": "https://api.apiture.com/schemas/audit/records/v1.0.0/profile.json",
  "start": 0,
  "limit": 1000,
  "count": 1000,
  "name": "records",
  "_links": {
    "self": {
      "href": "/audit/records?category=transfers"
    },
    "next": {
      "href": "/audit/records?category=transfers&start=1000&limit=1000"
    },
    "collection": {
      "href": "/audit/records"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/audit/record/v1.0.0/profile.json",
        "type": "transferScheduled",
        "occurredAt": {},
        "username": "lucy.wellphunded@bankcustomer.example.com",
        "host": "13.226.38.34",
        "primaryUri": "/transfers/scheduledTransfer/a727ff2a-08ea-42ce-b8dc-edea60646819",
        "data": {
          "sourceAccount": "9876543210",
          "sourceRoutingNumber": "021000021",
          "targetAccount": "9876543219",
          "targetRoutingNumber": "021000021",
          "amount": "1500.00",
          "currency": "USD",
          "start": {}
        },
        "links": {
          "self": {
            "href": "/audit/records/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:type": {
            "href": "/audit/types/transferScheduled"
          }
        }
      }
    ]
  }
}

Audit Record Collection

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

Properties

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

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

Properties

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

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

Properties

link

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

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.

Properties

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "message": "The value for deposit must be greater than 0.",
  "statusCode": 422,
  "type": "positiveNumberRequired",
  "attributes": {
    "value": -125.5
  },
  "remediation": "Provide a value which is greater than 0",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

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

Properties

attributes

{}

Attributes

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

Properties

links

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

Links

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

Properties