API Keys v0.32.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.

API Keys provide secure access to Apiture APIs. Each client application requires a unique API key to access the APIs in each runtime API environment (such as api.canapi.bank, api.devbank.apiture.com, or api.3rdparty.bank).

The API Key resource managed by this API creates the following:

• The API Key which is passed in the API-Key request header of each API call;
• A unique Client ID and Client Secret (also known as client credentials) with which the client application can authenticate with the authentication endpoints in the service.

Each key resource requires a client application and a target runtime api environment when constructing the API key. These resources are passed in the createKey operation via links in the request body via the link relations:

• apiture:clientApplication
• apiture:environment

The client application may be associated with a partner organization (business).

Each key may be in one of several states (pending, active, inactive); Keys are initially created in the pending state. State transitions are performed by a POST via the activateKey, deactivateKey operations using the links in the key resource:

• apiture:activate
• apiture:deactivate

which must be initially performed by a administrator with permission to approve keys. Users may deactivate/reactivate keys after they have been approved. Deactivating a key is also called revoking a key.

When a client application is deactivated, all its associated keys and client credentials are deactivated.

When a client application is activated, all its associated keys and client credentials are activated.

When a client application is deleted, all its associated keys and client credentials are deleted. There are five types of keys

• The Discoverer Key (discoverer) is for unauthenticated users to explore the Apiture APIs in a limited manner, using a sample user ("John Smith") identity. The Discoverer Key is shared by all unauthenticated users. It is recycled on a periodic basis: a new Discoverer key is minted each day to replace the old one, and the old one is then revoked, marked as expired, and deleted at some time after that.
• An Explorer key (explorer) is for authenticated users to explore the Apiture APIs in more depth. It is provisioned after a user registers (moderated by the portal admin). Using this, the developer can also create sample data that only they can access (bank accounts, etc.). The user can view their Explorer key via their My Account page on the developer portal.
• Partner keys (partner) are associated with a specific client partner organization (company), a registered client application, and a specific runtime environment (such as a dev, test, or other environment.
• Production keys (production) are partner keys that are attached to a production (non-test, non-development) environment.
• Private keys (private) are for Apiture use only.

This API provides convenient operations for creating or accessing Discoverer and Explorer keys.

Finally, the API provides a way to update keys with critical information from the client application when the application owner has changed those properties (such as the application redirect URL).

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.

appRefNotFound

Description: The clientApplication parameter was malformed or does not refer to an existing or client application.
Remediation: Pass a valid client application _id or URI for the clientApplication parameter.

invalidPartnerDomain

Description: The current user's email address is associated with a restricted partner organization domain.
Remediation: Register using a company email address, not an email service.

keyRefNotFound

Description: The key parameter was malformed or does not refer to an existing or accessible key.
Remediation: Pass a valid key in the key query parameter.

passwordRequired

Description: When updating the discoverer key credentials, the sampleUserPassword property is required if the request includes the sampleUserName.
Remediation: Pass sampleUserPassword if the request includes the sampleUserName.

Download OpenAPI Definition (YAML)

Base URLs:

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

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://developer.apiture.com/auth/oauth2/authorize
  • Token URL = https://developer.apiture.com/auth/oauth2/token

Scope	Scope Description
data/read	Read access to API keys.
admin/write	Write (update) access to API keys.
data/write	Write (update) access to API keys.
admin/delete	Delete access to API keys.
admin/full	Full access to API keys.

Key

Keys for secure API access.

getKeys

Code samples

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

GET https://api.apiture.com/apiKeys/keys HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/keys',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/apiKeys/keys',
  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('https://api.apiture.com/apiKeys/keys', params={

}, headers = headers)

print r.json()

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

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

Return a collection of keys

GET https://api.apiture.com/apiKeys/keys

Return a paginated filterable collection of keys. The links in the response include pagination links. The authenticated user can only access keys for applications in their partner domain (i.e. developers registered with validated emails with a @mycompany.com email domain can only see keys for that company), the discoverer key, and their own explorer key.

Parameters

Parameter	Description
start in: query	string Represents the first record of the page of results. This is supplied by the service when paginating items: the next link includes a ?start= query parameter which refers to beginning of the next page of items.
limit in: query	integer(int32) The maximum number of key representations to return in this page. format: int32 default: 100
application in: query	string Filter API keys to only those for this client application. The value is the client application ID. This value is merged with the ?filter= parameter (if any) and ?environment= parameter (if any) with an implicit and.
partner in: query	string Filter API keys to only those for this partner organization. The value is the partner ID or partner domain. This value is merged with the ?filter= parameter (if any) and ?environment= parameter (if any) with an implicit and.
environment in: query	string Filter API keys to only those for this environment. The value is the environment ID. This value is merged with the ?filter= parameter and ?application or ?partner parameter with an implicit and.
productLine in: query	productLine Subset the resources to only those whose productLine matches the query. default: "open" enum values: open, adb
filter in: query	string Optional filter criteria. See filtering.
state in: query	array[string] Subset the resources to only those whose state matches the query, such as ?state=active. The value may be a | separated list of states, such as ?state=pending|active to match all resources whose state is either pending or active. If ?filter= is also used, the two are combined with an implicit and() operation. pipe-delimited items: string » enum values: pending, active, inactive, rejected

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/keys/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "https://api.developer.apiture.com/apiKeys/keys"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "keys",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

createKey

Code samples

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

POST https://api.apiture.com/apiKeys/keys HTTP/1.1
Host: api.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_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"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/dd5122bd-a8cd-4d23-a001-d29fcdf346cc"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/d85d9eb2-4d4b-4cdf-8b69-5a3ea0ddfaac"
    }
  },
  "name": "3rd Party Bank web application at api.3rdparty.bank (production)"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Create a new key

POST https://api.apiture.com/apiKeys/keys

Create a new key in the keys collection. The key's state is initially pending but will change to active when the key has been deployed in the target environment. The associated client application and the target API environment to must be passed in the href of the corresponding _links in the request:

• apiture:clientApplication
• apiture:environment

This fails if there is an existing key in the pending, active or inactive state for the named client application and API environment. The key's type is set to partner or production, depending on the type of the key's environment.

Body parameter

{
  "_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"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/dd5122bd-a8cd-4d23-a001-d29fcdf346cc"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/d85d9eb2-4d4b-4cdf-8b69-5a3ea0ddfaac"
    }
  },
  "name": "3rd Party Bank web application at api.3rdparty.bank (production)"
}

Parameters

Parameter	Description
noNotification in: query	boolean If true, suppress the notification (typically, email) to the key/application owner or admin that a key has been created or the state of the API key has changed. If false (default), send the notification. Use ?noNotification=true when activating/deactivating a client application and the notification for that operation suffices (so the user does not receive too many emails all at once.) default: false
body	createKey (required) The data necessary to create a new key.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

getKey

Code samples

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

GET https://api.apiture.com/apiKeys/keys/{keyId} HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/keys/{keyId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/keys/{keyId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/apiKeys/keys/{keyId}',
  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('https://api.apiture.com/apiKeys/keys/{keyId}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of this key

GET https://api.apiture.com/apiKeys/keys/{keyId}

Return a HAL representation of this key resource.

Parameters

Parameter	Description
keyId in: path	string (required) The unique identifier of this key. This is an opaque string. This is not the actual API Key; the API-Key header is the key property.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

updateKey

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/apiKeys/keys/{keyId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.apiture.com/apiKeys/keys/{keyId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/keys/{keyId}',
  method: 'put',

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.apiture.com/apiKeys/keys/{keyId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.apiture.com/apiKeys/keys/{keyId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/keys/{keyId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.apiture.com/apiKeys/keys/{keyId}", data)
    req.Header = headers

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

Update this key

PUT https://api.apiture.com/apiKeys/keys/{keyId}

Perform a complete replacement of this key.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Parameters

Parameter	Description
keyId in: path	string (required) The unique identifier of this key. This is an opaque string. This is not the actual API Key; the API-Key header is the key property.
body	key (required) An API key.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

patchKey

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/apiKeys/keys/{keyId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/apiKeys/keys/{keyId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/keys/{keyId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.apiture.com/apiKeys/keys/{keyId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.apiture.com/apiKeys/keys/{keyId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/keys/{keyId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/apiKeys/keys/{keyId}", data)
    req.Header = headers

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

Update this key

PATCH https://api.apiture.com/apiKeys/keys/{keyId}

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

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Parameters

Parameter	Description
keyId in: path	string (required) The unique identifier of this key. This is an opaque string. This is not the actual API Key; the API-Key header is the key property.
body	key (required) An API key.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

deleteKey

Code samples

# You can also use wget
curl -X DELETE https://api.apiture.com/apiKeys/keys/{keyId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.apiture.com/apiKeys/keys/{keyId} HTTP/1.1
Host: api.apiture.com

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

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

};

fetch('https://api.apiture.com/apiKeys/keys/{keyId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/keys/{keyId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.apiture.com/apiKeys/keys/{keyId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.apiture.com/apiKeys/keys/{keyId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/keys/{keyId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.apiture.com/apiKeys/keys/{keyId}", data)
    req.Header = headers

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

Delete this key resource

DELETE https://api.apiture.com/apiKeys/keys/{keyId}

Delete this key resource and any resources that are owned by it.

Parameters

Parameter	Description
keyId in: path	string (required) The unique identifier of this key. This is an opaque string. This is not the actual API Key; the API-Key header is the key property.

Responses

Key Actions

Change the state of API keys.

activateKey

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/activeKeys?key=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/activeKeys?key=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/activeKeys?key=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/activeKeys',
  params: {
  'key' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/activeKeys', params={
  'key': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/activeKeys?key=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Activate a key

POST https://api.apiture.com/apiKeys/activeKeys

Attempt to activate a key.
For non-administrators, this submits a request to the portal administrators to approve or reject the request. This may also change the state to pending. The corresponding response code is 200.
For administrator users, this action changes the state directly (if the state can be changed to active or is already active). The API key is also deployed into the target environment. This also activates the corresponding application if it is not already active. The corresponding response code is 200.
This operation is available via the apiture:activate link on the key resource, if and only if the key is eligible for the activate operation. The response is the updated representation of the key.

Parameters

Parameter	Description
key in: query	string (required) A string which uniquely identifies a key which is to added to the activeKeys or inactiveKeys resource sets. This may be the unique keyId or the URI of the key.
noNotification in: query	boolean If true, suppress the notification (typically, email) to the key/application owner or admin that a key has been created or the state of the API key has changed. If false (default), send the notification. Use ?noNotification=true when activating/deactivating a client application and the notification for that operation suffices (so the user does not receive too many emails all at once.) default: false

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

rejectKey

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/rejectedKeys?key=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/rejectedKeys?key=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/rejectedKeys?key=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/rejectedKeys',
  params: {
  'key' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/rejectedKeys', params={
  'key': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/rejectedKeys?key=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Reject a key

POST https://api.apiture.com/apiKeys/rejectedKeys

Reject a key. For administrators only. This change the state to rejected. This operation also removes the key from the target environment if the state was active. is available via the apiture:reject link on the key resource, if and only if the key is eligible for the activate operation. The response is the updated representation of the key.

Parameters

Parameter	Description
key in: query	string (required) A string which uniquely identifies a key which is to added to the activeKeys or inactiveKeys resource sets. This may be the unique keyId or the URI of the key.
noNotification in: query	boolean If true, suppress the notification (typically, email) to the key/application owner or admin that a key has been created or the state of the API key has changed. If false (default), send the notification. Use ?noNotification=true when activating/deactivating a client application and the notification for that operation suffices (so the user does not receive too many emails all at once.) default: false

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

deactivateKey

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/inactiveKeys?key=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/inactiveKeys?key=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/inactiveKeys?key=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/inactiveKeys',
  params: {
  'key' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/inactiveKeys', params={
  'key': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/inactiveKeys?key=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Deactivate a key

POST https://api.apiture.com/apiKeys/inactiveKeys

Update a key by adding it to the set of inactive keys. This changes the state property of the key to inactive. This operation is available via the apiture:deactivate link on the key resource, if and only if the key is eligible for the deactivate operation. The API key is also removed from the target environment. The response is the updated representation of the key.

Parameters

Parameter	Description
key in: query	string (required) A string which uniquely identifies a key which is to added to the activeKeys or inactiveKeys resource sets. This may be the unique keyId or the URI of the key.
noNotification in: query	boolean If true, suppress the notification (typically, email) to the key/application owner or admin that a key has been created or the state of the API key has changed. If false (default), send the notification. Use ?noNotification=true when activating/deactivating a client application and the notification for that operation suffices (so the user does not receive too many emails all at once.) default: false

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

updateKeys

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/updatedKeys?clientApplication=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/updatedKeys?clientApplication=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/updatedKeys?clientApplication=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/updatedKeys',
  params: {
  'clientApplication' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/updatedKeys', params={
  'clientApplication': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/updatedKeys?clientApplication=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update keys with changes from the client application

POST https://api.apiture.com/apiKeys/updatedKeys

Call this when a client application owner has changed properties of a client application. This operation propagates those changes into all the API keys for the application referenced by the clientApplication parameter. Changes include the application name and the application redirectUrl.

Parameters

Parameter	Description
clientApplication in: query	string (required) The unique _id or URL of a client application.

Example responses

422 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Discoverer Key

Access to Discoverer Keys

getDiscovererKey

Code samples

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

GET https://api.apiture.com/apiKeys/discovererKey HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/discovererKey',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return the Discoverer Key

GET https://api.apiture.com/apiKeys/discovererKey

Returns the active Discoverer Key. If the Discoverer Key has not been created, this call creates, activates, and returns it. The key's type is set to discoverer. If the key exists, it is returned. The Discoverer Key is associated with the Dev Portal application and is only valid in the DevBank environment.

Example responses

200 Response

{
  "_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"
    }
  }
}

Responses

discovererKey

Code samples

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

POST https://api.apiture.com/apiKeys/discovererKey HTTP/1.1
Host: api.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "sampleUserName": "user.name@example.com",
  "sampleUserPassword": "string"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Create or recycle the Discoverer Key

POST https://api.apiture.com/apiKeys/discovererKey

Creates or recycles the Discoverer Key. If the Discoverer Key has not been created, this call creates, activates, and returns it. If the key exists, the old key is recycled (scheduled to be removed but left active) and a new Discoverer key is created, activated, and returned.

If the request body contains new credentials for the sample user, the service saves those new credentials used for creating the discoverer key and discoverer access token.

The Discoverer Key is associated with the Dev Portal application and is only valid in the DevBank environment.

Only the administrator or system can create or recycle the discoverer key.

Body parameter

{
  "sampleUserName": "user.name@example.com",
  "sampleUserPassword": "string"
}

Parameters

Parameter	Description
productLine in: query	productLine Subset the resources to only those whose productLine matches the query. default: "open" enum values: open, adb
body	discoverKeyRequest (required) Optional credentials to reset the user name and password of the sample user used for creating/refreshing the discoverer key and access token.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

Explorer Key

Access to Explorer Keys

getExplorerKey

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/apiKeys/explorerKey?environment=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/apiKeys/explorerKey?environment=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKey?environment=string',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/explorerKey',
  method: 'get',
  data: '?environment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/apiKeys/explorerKey',
  params: {
  'environment' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/apiKeys/explorerKey', params={
  'environment': 'string'
}, headers = headers)

print r.json()

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

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

Return the user's Explorer Key

GET https://api.apiture.com/apiKeys/explorerKey

Returns the user's Explorer Key for a target environment.

An Explorer Key is associated with the Dev Portal application client application and one of the target environments associated with the dev portal. (Thus, a user may have multiple explorer keys, one per environment.)

Parameters

Parameter	Description
environment in: query	string (required) The target API environment ID or host name where the explorer key is deployed.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

explorerKey

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/explorerKey?environment=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/explorerKey?environment=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKey?environment=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/explorerKey',
  params: {
  'environment' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/explorerKey', params={
  'environment': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/explorerKey?environment=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create or recycles the user's Explorer Key

POST https://api.apiture.com/apiKeys/explorerKey

Creates and returns the user's Explorer Key for a given environment. If the Explorer Key has not been created, this call creates and returns it, but leaves it in a pending state, awaiting administrator approval. If the key exists, the old key is recycled (scheduled to be removed but left active) and a new Explorer key is created, activated, and returned. The key's type is set to explorer.

The Explorer Key is specific and private to the current authenticated user. It has a name which is the concatenation of the user's user name (email address), "Explorer", such as "walter.black@cool.example.com Explorer".

The Explorer Key is associated with the Dev Portal application and is only valid in the DevBank environment or where the domain name of the user's email address is listed in the API environment's domains.

Parameters

Parameter	Description
environment in: query	string (required) The target API environment ID or host name where the explorer key is deployed.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Responses

generateSampleData

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration?requestId=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration?requestId=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration?requestId=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration',
  method: 'post',
  data: '?requestId=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration',
  params: {
  'requestId' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration', params={
  'requestId': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration?requestId=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create sample data for the user

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataGeneration

Create sample data for the user using their explorer key. This operation is only called from createSampleDataRequest to start the data generation asynchronously. This operation does not use a request body.

Note This operation will move from this API to a dev portal users API, but that API does not yet exist.

Parameters

Parameter	Description
requestId in: query	string (required) A reference to the internal sample data request containing the user, explorer key, environment, and environment token. This requestId is generated from the createSampleDataRequest operation.

Example responses

202 Response

{
  "_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"
    }
  }
}

Responses

checkSampleDataRequest

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest',
  method: 'get',
  data: '?environment=string&environmentAccessToken=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest',
  params: {
  'environment' => 'string',
'environmentAccessToken' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest', params={
  'environment': 'string',  'environmentAccessToken': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string");
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", "https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest", data)
    req.Header = headers

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

Check sample data request status

GET https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest

Return the status of the sample data request for an environment. The state property conveys the status of the request.

Note This operation will move from this API to a dev portal users API, but that API does not yet exist.

Parameters

Parameter	Description
environment in: query	string (required) The target API environment ID or host name where the explorer key is deployed.
environmentAccessToken in: query	string (required) The access token which grants the user access to the target environment. The (dev portal) application obtains this token when the user authenticates against the client environment.

Example responses

200 Response

{
  "_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"
    }
  }
}

Responses

createSampleDataRequest

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest',
  method: 'post',
  data: '?environment=string&environmentAccessToken=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest',
  params: {
  'environment' => 'string',
'environmentAccessToken' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest', params={
  'environment': 'string',  'environmentAccessToken': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest?environment=string&environmentAccessToken=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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create sample data for the user

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest

Create sample data for the user using their explorer key. This creates an account for the user and then runs the transaction tool to create some fictional historical transactions for the user. If invoked multiple times, it will run the processes again. This operation is asynchronous. The explorer key must be active. This operation does not use a request body.

Note This operation will move from this API to a dev portal users API, but that API does not yet exist.

Parameters

Parameter	Description
environment in: query	string (required) The target API environment ID or host name where the explorer key is deployed.
environmentAccessToken in: query	string (required) The access token which grants the user access to the target environment. The (dev portal) application obtains this token when the user authenticates against the client environment.

Example responses

202 Response

{
  "_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"
    }
  }
}

Responses

resetSampleDataRequestCounter

Code samples

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

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter HTTP/1.1
Host: api.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/sampleDataCounterReset/v1.0.1/profile.json",
  "_links": {},
  "username": "max.peck@nasa.gov",
  "environment": "api.devbank.apiture.com"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter");
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/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Reset a user's sample data request counter

POST https://api.apiture.com/apiKeys/explorerKey/sampleDataRequest/counter

The API enforces a limit of the number of times a user may request sample data. However, if the sample generation fails repeatedly for the user, they may reach the limit without any data being generated for them. An administrator can use this operation to reset the counter back to zero so the user can try again.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/sampleDataCounterReset/v1.0.1/profile.json",
  "_links": {},
  "username": "max.peck@nasa.gov",
  "environment": "api.devbank.apiture.com"
}

Parameters

Parameter	Description
body	sampleDataCounterReset (required) Request resetting the sample data counter back to zero for a user.

Example responses

202 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/sampleDataCounterReset/v1.0.1/profile.json",
  "_links": {},
  "username": "max.peck@nasa.gov",
  "environment": "api.devbank.apiture.com"
}

Responses

getExplorerKeys

Code samples

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

GET https://api.apiture.com/apiKeys/explorerKeys HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.apiture.com/apiKeys/explorerKeys',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/apiKeys/explorerKeys',
  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('https://api.apiture.com/apiKeys/explorerKeys', params={

}, headers = headers)

print r.json()

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

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

Get a Explorer Keys

GET https://api.apiture.com/apiKeys/explorerKeys

Return the explorer keys for a partner domain or user. This is an admin-only operation.

Parameters

Parameter	Description
owner in: query	string(email) Filter API keys to only those keys for this owner's email address. format: email
environment in: query	string Filter API keys to only those keys whose environment ID, name, or hostname match this value.
state in: query	array[string] Subset the resources to only those whose state matches the query, such as ?state=active. The value may be a | separated list of states, such as ?state=pending|active to match all resources whose state is either pending or active. If ?filter= is also used, the two are combined with an implicit and() operation. pipe-delimited items: string » enum values: pending, active, inactive, rejected
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions:.
start in: query	string Represents the first record of the page of results. This is supplied by the service when paginating items: the next link includes a ?start= query parameter which refers to beginning of the next page of items.
limit in: query	integer(int32) The maximum number of key representations to return in this page. format: int32 default: 100

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/explorerKeys/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.developer.apiture.com/apiKeys/explorerKeys"
    },
    "next": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=p4900sk3df9&limit=10"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "keys",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "owner": "Walter.Black@example.com",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/explorerKey/v1.4.0/profile.json",
        "name": "Explorer Key Walter.Black@example.com",
        "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
        "clientId": "1b97ad67397640c89208bdfd1e039b1f",
        "clientSecret": "5035cef945054f96a56d07620652b6bf",
        "applicationName": "Dev Portal",
        "partnerName": "Example",
        "partnerDomain": "example.com",
        "_links": {
          "apiture:clientApplication": {
            "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
          },
          "apiture:partner": {
            "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
          },
          "apiture:environment": {
            "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
          },
          "apiture:deactivate": {
            "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      }
    ]
  }
}

Responses

API

Endpoints which describe this API.

getApi

Code samples

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

GET https://api.apiture.com/apiKeys/ HTTP/1.1
Host: api.apiture.com
Accept: application/hal+json

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Top-level resources and operations in this API

GET https://api.apiture.com/apiKeys/

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

GET https://api.apiture.com/apiKeys/apiDoc HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/apiKeys/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.apiture.com/apiKeys/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.apiture.com/apiKeys/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

Return API definition document

GET https://api.apiture.com/apiKeys/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

Name	Description
Abstract Request (v2.0.0)	object An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource. This schema was resolved from common/abstractRequest.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

Name	Description
Abstract Resource (v2.1.0)	object An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links. This schema was resolved from common/abstractResource.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

attributes

{}

Attributes (v2.1.0)

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

This schema was resolved from common/attributes.

Properties

Name	Description
Attributes (v2.1.0)	object An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

authorizationScope

{
  "name": "string",
  "description": "string"
}

Authorization Scope (v1.0.0)

Authorization scope associated with an API or an API product.

This schema was resolved from apiProducts/authorizationScope.

Properties

Name	Description
Authorization Scope (v1.0.0)	object Authorization scope associated with an API or an API product. This schema was resolved from apiProducts/authorizationScope.
name	authorizationScopeName (required) The name of an authorization scope associated with an API or an API product. This schema was resolved from apiProducts/authorizationScopeName. maxLength: 32
description	string (required) The description of the scope. maxLength: 128

authorizationScopeName

"string"

Authorization Scope Name (v1.0.0)

The name of an authorization scope associated with an API or an API product.

This schema was resolved from apiProducts/authorizationScopeName.

type: string

maxLength: 32

createKey

{
  "_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"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/dd5122bd-a8cd-4d23-a001-d29fcdf346cc"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/d85d9eb2-4d4b-4cdf-8b69-5a3ea0ddfaac"
    }
  },
  "name": "3rd Party Bank web application at api.3rdparty.bank (production)"
}

Create Key (v1.0.1)

Request body to create a new API key. The request must contain links as described in the createKey schema. The type of the key is determined by the environment's type.

Links

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

Rel	Summary	Method
apiture:clientApplication		GET
apiture:environment		GET

Properties

Name	Description
Create Key (v1.0.1)	object Request body to create a new API key. The request must contain links as described in the createKey schema. The type of the key is determined by the environment's type. Links Response and request bodies using this createKey schema may contain the following links: Rel Summary Method apiture:clientApplication GET apiture:environment 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
name	string The name of the API key. If not passed when creating a key, the name is derived by concatenating the application name, the partner organization domain name,and the key's type. Names need not be unique (each key's _id is generated by the server and unique). minLength: 6 maxLength: 128

cursorPagedCollection

{
  "_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"
    }
  }
}

Cursor Paged Collection (v2.1.1)

A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start. The _links in the collection may contain pagination links:

• the next link returns the next page of items. If there is no next link, the collection has been exhausted.
• the first link returns to the beginning of the filtered/sorted collection.
• the collection link returns to the beginning of the default collection with no explicit filter or sort criteria.

Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records.

This schema was resolved from common/cursorPagedCollection.

Properties

Name	Description
Cursor Paged Collection (v2.1.1)	object A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start. The _links in the collection may contain pagination links: the next link returns the next page of items. If there is no next link, the collection has been exhausted. the first link returns to the beginning of the filtered/sorted collection. the collection link returns to the beginning of the default collection with no explicit filter or sort criteria. Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records. This schema was resolved from common/cursorPagedCollection.
_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
start	string An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links.
limit	integer The maximum number of items per page.
name	string A name for the items in collection.

discoverKeyRequest

{
  "sampleUserName": "user.name@example.com",
  "sampleUserPassword": "string"
}

Discover Key Request (v1.0.0)

Data the admin can pass when creating or recycling the discoverer key. This is optional, but may contain new credentials for the sample user. If sampleUserName is passed, the request must also contain sampleUserPassword. If only sampleUserPassword is passed, the request will update the password for the current sample user.

Properties

Name	Description
Discover Key Request (v1.0.0)	object Data the admin can pass when creating or recycling the discoverer key. This is optional, but may contain new credentials for the sample user. If sampleUserName is passed, the request must also contain sampleUserPassword. If only sampleUserPassword is passed, the request will update the password for the current sample user.
sampleUserName	string(email) The user name (login user ID) of the user used for sample data. This user must exist in the devbank environment used by the portal. format: email
sampleUserPassword	string The password of the sample user.

discovererKey

{
  "_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"
    }
  }
}

Discoverer Key (v1.4.0)

An API key and access token for an unauthenticated user to make API calls against the devbank target environment.

Properties

Name	Description
Discoverer Key (v1.4.0)	object An API key and access token for an unauthenticated user to make API calls against the devbank target environment.
_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
apiKey	key The API key for Discoverer use.
accessToken	string An OAuth access token which may be used for API calls on the devbank environment. This token expires every hour. The client should fetch a new access token before this expires.

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

explorerKey

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Explorer Key (v1.4.0)

A user's explorer key.

Properties

Name	Description
Explorer Key (v1.4.0)	object A user's explorer key.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name of the API key. If not passed when creating a key, the name is derived by concatenating the application name, the partner organization domain name,and the key's type. Names need not be unique (each key's _id is generated by the server and unique). minLength: 6 maxLength: 128
_id	string The resource ID of this API key resource. This is not the actual API Key; the API-Key header is the key property. read-only minLength: 6 maxLength: 40
key	string The value of the API key, to be used in the API-Key request header on API calls. read-only minLength: 6 maxLength: 64
applicationName	string The name of the client application for this API key. This is derived from the apiture:clientApplication resource passed in at creation time. read-only minLength: 4 maxLength: 64
environmentName	string The name of the API environment for this API key. This is derived from the apiture:environment resource passed in at creation time. read-only minLength: 6 maxLength: 64
environmentHost	string The name of the API environment host for this API key. This is derived from the apiture:environment resource passed in at creation time. read-only minLength: 4 maxLength: 64
partnerName	string The name of the optional partner organization/company. This is derived from the partner organization associated with the application. read-only minLength: 4 maxLength: 128
partnerDomain	string(urn) The web domain of the optional partner organization/company. This is derived from the partner organization associated with the application. read-only format: urn minLength: 4 maxLength: 128
clientId	string The client ID portion of the client credentials associated with the API key. read-only minLength: 6 maxLength: 128
clientSecret	string The client secret portion of the client credentials associated with the API key. read-only minLength: 6 maxLength: 128
decryptionPublicKey	string A server-assigned public decryption key that the client must use to decrypt the encrypted data sent from the banking service. The client must use this key to decrypt the connect data sent to the client application's connectUrl and disconnectUrl endpoints and the auth data sent to the authUrl endpoint. This key is only for decrypting and is not related to the encryptionPublicKey. This property is only generated if the client application uses a component API product. read-only
encryptionPrivateKey	string A server-assigned private encryption key the client application uses to encrypt sensitive data the client sends to the banking service. This key is not related to the decryptionPublicKey. The client should keep this secure and secret. This property is only generated if the client application uses a component API product. read-only
type	keyType Defines what type of key this is. read-only enum values: discoverer, explorer, partner, production, private
state	keyState The current state of the key. This is immutable and derived, based on the actions to activate or deactivate the key via the activateKey and deactivateKey operations. The initial state is pending; it changes to active when the API key and credentials have been deployed into the target environment via the activateKey operation. This property is only generated if the client application uses a component API product. read-only enum values: pending, active, inactive, rejected
scopes	array: [authorizationScope] The authorization scopes associated with this API product. This is derived from the scopes associated with this key's client application. read-only unique items items: object
productLine	productLine The product line, derived from the productLine of the client application. read-only default: "open" enum values: open, adb
serviceConnections	serviceConnections Additional API and feature connection properties. Service connections apply only to applications with type of service and which use the clientCredentials authentication type. read-only
createdAt	string(date-time) The date-time when the key was created. This is an RFC 3336 formatted string in UTC time. read-only format: date-time
expiresAt	string(date-time) The date-time when the key expires. If this is omitted, the key does not have an expiration time. (This expiration is typically is used only for Discoverer keys). This is an RFC 3336 formatted string in UTC time. read-only format: date-time
owner	string(email) The email address of the owner. format: email

explorerKeys

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/explorerKeys/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.developer.apiture.com/apiKeys/explorerKeys"
    },
    "next": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=p4900sk3df9&limit=10"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "keys",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "owner": "Walter.Black@example.com",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/explorerKey/v1.4.0/profile.json",
        "name": "Explorer Key Walter.Black@example.com",
        "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
        "clientId": "1b97ad67397640c89208bdfd1e039b1f",
        "clientSecret": "5035cef945054f96a56d07620652b6bf",
        "applicationName": "Dev Portal",
        "partnerName": "Example",
        "partnerDomain": "example.com",
        "_links": {
          "apiture:clientApplication": {
            "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
          },
          "apiture:partner": {
            "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
          },
          "apiture:environment": {
            "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
          },
          "apiture:deactivate": {
            "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      }
    ]
  }
}

Explorer Keys List (v1.4.0)

Collection of explorer keys.

Properties

Name	Description
Explorer Keys List (v1.4.0)	object Collection of explorer keys.
_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: [explorerKey] An array containing a page of key 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
start	string An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links.
limit	integer The maximum number of items per page.
name	string A name for the items in collection.

key

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:clientApplication": {
      "href": "https://api.developer.apiture.com/clientApplications/applications/00aaf46d-05c2-4237-9305-fd9ed9c4994b"
    },
    "apiture:partner": {
      "href": "https://api.developer.apiture.com/partners/organizations/2435a7f0-2650-49df-9988-c113e36e3c96"
    },
    "apiture:environment": {
      "href": "https://api.developer.apiture.com/apiEnvironments/environments/8c112888-f139-4583-bb0e-cbd378550a48"
    },
    "apiture:deactivate": {
      "href": "https://api.developer.apiture.com/apiKeys/inactiveKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:reject": {
      "href": "https://api.developer.apiture.com/apiKeys/rejectedKeys?key=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "My Apiture POC",
  "key": "295fd0e8b0b449f9a5a3dbfd4a3e3149",
  "clientId": "1b97ad67397640c89208bdfd1e039b1f",
  "clientSecret": "5035cef945054f96a56d07620652b6bf",
  "applicationName": "My Apiture POC",
  "partnerName": "Example FinTex",
  "partnerDomain": "fintech.example.com",
  "state": "active"
}

Key (v1.4.0)

API key resources.

Links

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

Rel	Summary	Method
apiture:activate	Activate a key	POST
apiture:reject	Reject a key	POST
apiture:deactivate	Deactivate a key	POST

Properties

Name	Description
Key (v1.4.0)	object API key resources. Links Response and request bodies using this key schema may contain the following links: Rel Summary Method apiture:activate Activate a key POST apiture:reject Reject a key POST apiture:deactivate Deactivate a key POST
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name of the API key. If not passed when creating a key, the name is derived by concatenating the application name, the partner organization domain name,and the key's type. Names need not be unique (each key's _id is generated by the server and unique). minLength: 6 maxLength: 128
_id	string The resource ID of this API key resource. This is not the actual API Key; the API-Key header is the key property. read-only minLength: 6 maxLength: 40
key	string The value of the API key, to be used in the API-Key request header on API calls. read-only minLength: 6 maxLength: 64
applicationName	string The name of the client application for this API key. This is derived from the apiture:clientApplication resource passed in at creation time. read-only minLength: 4 maxLength: 64
environmentName	string The name of the API environment for this API key. This is derived from the apiture:environment resource passed in at creation time. read-only minLength: 6 maxLength: 64
environmentHost	string The name of the API environment host for this API key. This is derived from the apiture:environment resource passed in at creation time. read-only minLength: 4 maxLength: 64
partnerName	string The name of the optional partner organization/company. This is derived from the partner organization associated with the application. read-only minLength: 4 maxLength: 128
partnerDomain	string(urn) The web domain of the optional partner organization/company. This is derived from the partner organization associated with the application. read-only format: urn minLength: 4 maxLength: 128
clientId	string The client ID portion of the client credentials associated with the API key. read-only minLength: 6 maxLength: 128
clientSecret	string The client secret portion of the client credentials associated with the API key. read-only minLength: 6 maxLength: 128
decryptionPublicKey	string A server-assigned public decryption key that the client must use to decrypt the encrypted data sent from the banking service. The client must use this key to decrypt the connect data sent to the client application's connectUrl and disconnectUrl endpoints and the auth data sent to the authUrl endpoint. This key is only for decrypting and is not related to the encryptionPublicKey. This property is only generated if the client application uses a component API product. read-only
encryptionPrivateKey	string A server-assigned private encryption key the client application uses to encrypt sensitive data the client sends to the banking service. This key is not related to the decryptionPublicKey. The client should keep this secure and secret. This property is only generated if the client application uses a component API product. read-only
type	keyType Defines what type of key this is. read-only enum values: discoverer, explorer, partner, production, private
state	keyState The current state of the key. This is immutable and derived, based on the actions to activate or deactivate the key via the activateKey and deactivateKey operations. The initial state is pending; it changes to active when the API key and credentials have been deployed into the target environment via the activateKey operation. This property is only generated if the client application uses a component API product. read-only enum values: pending, active, inactive, rejected
scopes	array: [authorizationScope] The authorization scopes associated with this API product. This is derived from the scopes associated with this key's client application. read-only unique items items: object
productLine	productLine The product line, derived from the productLine of the client application. read-only default: "open" enum values: open, adb
serviceConnections	serviceConnections Additional API and feature connection properties. Service connections apply only to applications with type of service and which use the clientCredentials authentication type. read-only
createdAt	string(date-time) The date-time when the key was created. This is an RFC 3336 formatted string in UTC time. read-only format: date-time
expiresAt	string(date-time) The date-time when the key expires. If this is omitted, the key does not have an expiration time. (This expiration is typically is used only for Discoverer keys). This is an RFC 3336 formatted string in UTC time. read-only format: date-time

keyState

"pending"

Key State (v1.1.0)

Possible state of an API key.

keyState strings may have one of the following enumerated values:

Value	Description
pending	Pending: A key that has been requested but not activated (not approved).
active	Active: A key that has been approved and is active.
inactive	Inactive: A key that has been revoked and is not active. Inactive keys can be reactivated when the application is reactivated.
rejected	Rejected: A key that has been rejected and is not active.

type: string

enum values: pending, active, inactive, rejected

keyType

"discoverer"

Key Type (v1.0.0)

The type describe the purpose and use of the API key. This field is derived from the target environment used when the key is created.

keyType strings may have one of the following enumerated values:

Value	Description
discoverer	Discoverer Key: The Discoverer Key is for unauthenticated users to explore the Apiture APIs in a limited manner, using a sample user ("John Smith") identity. The Discoverer Key is shared by all unauthenticated users. It is recycled on a periodic basis: a new Discoverer key is minted each day to replace the old one, and the old one is then revoked, marked as expired, and deleted at some time after that.
explorer	Explorer Key: An Explorer key is for authenticated users to explore the Apiture APIs in more depth. It is provisioned after a user registers (moderated by the portal admin). Using this, the developer can also create sample data that only they can access (bank accounts, etc.). The user can view their Explorer key via their My Account page on the developer portal.
partner	Partner Key: Partner keys are associated with a specific client partner organization (company), a registered client application, and a specific runtime environment (such as a dev, test, or other environment.
production	Production Key: Production keys are partner keys that are attached to a production (non-test, non-development) environment.
private	Private Key: Private keys are for Apiture use only.

type: string

enum values: discoverer, explorer, partner, production, private

keys

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/keys/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "https://api.developer.apiture.com/apiKeys/keys?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "https://api.developer.apiture.com/apiKeys/keys"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "keys",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "https://production.api.apiture.com/schemas/apiKeys/key/v1.4.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.developer.apiture.com/apiKeys/keys/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Key Collection (v1.4.0)

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

Properties

Name	Description
Key Collection (v1.4.0)	object Collection of keys. The items in the collection are ordered in the _embedded.items array; the name is keys. The top-level _links object may contain pagination links: self, next, prev, first, last, collection.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object Embedded objects.
» items	array: [key] An array containing a page of key 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
start	string An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links.
limit	integer The maximum number of items per page.
name	string A name for the items in collection.

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.

productLine

"open"

Product Line (v1.0.0)

The product line, for separating Open APIs and products from ADB APIs and products.

productLine strings may have one of the following enumerated values:

Value	Description
open	open: Apiture Open
adb	adb: Apiture Digital Banking

This schema was resolved from apiProducts/productLine.

type: string

default: "open"
enum values: open, adb

queueConsumer

{
  "uri": "http://example.com",
  "accessKeyId": "string",
  "secretAccessKey": "string"
}

Queue Consumer (v1.0.0)

Properties which the client application can use to access an event queue via the AWS SQS SDK.

Properties

Name	Description
Queue Consumer (v1.0.0)	object Properties which the client application can use to access an event queue via the AWS SQS SDK.
uri	string(uri) (required) The SQS queue URI. read-only format: uri maxLength: 2048
accessKeyId	string (required) The access key ID that identifies the security credentials. read-only maxLength: 128
secretAccessKey	string (required) The secret access key that can be used to sign requests. read-only

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.

sampleDataCounterReset

{
  "_profile": "https://production.api.apiture.com/schemas/apiKeys/sampleDataCounterReset/v1.0.1/profile.json",
  "_links": {},
  "username": "max.peck@nasa.gov",
  "environment": "api.devbank.apiture.com"
}

Sample Data Counter Reset (v1.0.1)

A request to reset a user's sample data generation counter back to zero.

Properties

Name	Description
Sample Data Counter Reset (v1.0.1)	object A request to reset a user's sample data generation counter back to zero.
_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
username	string(email) (required) The username (email address) that the user uses to login to the developer portal. format: email
environment	string (required) The host name of the target environment where the user is trying to generate sample data. minLength: 8 maxLength: 64

sampleDataRequest

{
  "_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"
    }
  }
}

Sample Data Request (v1.0.1)

Reflects a user's request to create sample data in an environment.

Links

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

Rel	Summary	Method
apiture:environment		GET

Properties

Name	Description
Sample Data Request (v1.0.1)	object Reflects a user's request to create sample data in an environment. Links Response and request bodies using this sampleDataRequest schema may contain the following links: Rel Summary Method apiture:environment 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
state	sampleDataRequestState The state of the sample data request. enum values: none, started, completed, failed
environmentId	string The _id of the API environment. maxLength: 64
environmentName	string The name of the API environment. maxLength: 64

sampleDataRequestState

"none"

Sample Data Request State (v1.0.0)

The state of the sample data request.

type: string

enum values: none, started, completed, failed

serviceConnections

{
  "queueConsumer": {
    "uri": "http://example.com",
    "accessKeyId": "string",
    "secretAccessKey": "string"
  }
}

Service Connections (v1.0.0)

Additional API and feature connection properties. Service connections apply only to applications with type of service and which use the clientCredentials authentication type.

Properties

Name	Description
Service Connections (v1.0.0)	object Additional API and feature connection properties. Service connections apply only to applications with type of service and which use the clientCredentials authentication type.
queueConsumer	queueConsumer Properties which the client application can use to access an event queue via the AWS SQS SDK. read-only

---