Customer Sessions v0.3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The Customer Sessions API provides the mechanisms to manipulate authenticated sessions. This API allows the trusted caller to terminate or resume customer sessions on the back-end. When a session is resumed, the expiration is reset. This is an internal API and is not intended for public use.
Download OpenAPI Definition (YAML)
Base URLs:
License: Apiture API License
Customer Sessions
Customer Sessions
terminateCustomerSession
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/system/terminatedCustomerSessions \
-H 'Content-Type: application/json' \
-H 'Accept: application/problem+json'
POST https://api.apiture.com/system/terminatedCustomerSessions HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/problem+json
const fetch = require('node-fetch');
const inputBody = '{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/problem+json'
};
fetch('https://api.apiture.com/system/terminatedCustomerSessions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/problem+json'
};
$.ajax({
url: 'https://api.apiture.com/system/terminatedCustomerSessions',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/problem+json'
}
result = RestClient.post 'https://api.apiture.com/system/terminatedCustomerSessions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/problem+json'
}
r = requests.post('https://api.apiture.com/system/terminatedCustomerSessions', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/system/terminatedCustomerSessions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/problem+json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/system/terminatedCustomerSessions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Terminate a customer session
POST https://api.apiture.com/system/terminatedCustomerSessions
Terminates a customer session and prevents any further use of the session.
Body parameter
{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e"
}
Parameters
Parameter | Description |
---|---|
body | customerSession (required) |
Example responses
400 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
"title": "Bad Request",
"status": 400,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "Input did not parse as JSON",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The operation succeeded but returned no response body. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
resumeCustomerSession
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/system/resumedCustomerSessions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.apiture.com/system/resumedCustomerSessions HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e",
"customerId": "9fa37c6c-2198",
"institutionId": "BOOIL"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.apiture.com/system/resumedCustomerSessions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
$.ajax({
url: 'https://api.apiture.com/system/resumedCustomerSessions',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.apiture.com/system/resumedCustomerSessions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.apiture.com/system/resumedCustomerSessions', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/system/resumedCustomerSessions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/system/resumedCustomerSessions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Resume a customer session
POST https://api.apiture.com/system/resumedCustomerSessions
Resume a customer session and reset any expiration timeout associated with this session. Allows the customer to continue to use the session without requiring session verification. This operation might create a new session if the customer session had expired.
Body parameter
{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e",
"customerId": "9fa37c6c-2198",
"institutionId": "BOOIL"
}
Parameters
Parameter | Description |
---|---|
body | resumedCustomerSession (required) |
Example responses
200 Response
{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The customer session was extended. | |
Schema: customerSession | |
201 | Created |
Created. A new customer session was initiated. | |
Schema: customerSession |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Schemas
apiProblem
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists at the given account_url",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
API Problem (v1.2.1)
API problem or error, as per RFC 7807 application/problem+json.
Properties
Name | Description |
---|---|
API Problem (v1.2.1) | API problem or error, as per RFC 7807 application/problem+json. |
type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" .format: uri-reference maxLength: 2048 |
title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type .format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048 |
id | The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.read-only format: date-time minLength: 20 maxLength: 30 |
problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
challengeFactor
{
"type": "sms",
"labels": [
"9876"
]
}
Challenge Factor (v1.2.1)
An challenge factor. See requiredIdentityChallenge
for multiple examples.
Properties
Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Challenge Factor (v1.2.1) | An challenge factor. See requiredIdentityChallenge for multiple examples. | ||||||||||||
id | The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The | ||||||||||||
type | (required) The name of challenge factor.
enum values: sms , email , voice , securityQuestions , authenticatorToken | ||||||||||||
labels | array: [ A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300 | ||||||||||||
securityQuestions | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions . |
challengeFactorId
"string"
Challenge Factor ID (v1.0.0)
The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
type:
string
minLength: 3
maxLength: 48
pattern: ^[-a-zA-Z0-9$_]{3,48}$
challengeFactorType
"sms"
Challenge Factor Type (v1.0.0)
The name of challenge factor.
challengeFactorType
strings may have one of the following enumerated values:
Value | Description |
---|---|
sms | SMS: One-time passcode sent to the primary mobile phone number |
email | Email: One-time passcode sent to the primary email address |
voice | Voice: One-time passcode communicated via automated voice phone call |
authenticatorToken | authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app |
securityQuestions | Security Questions: Prompt with the user's security questions registered with their security profile |
type:
string
enum values: sms
, email
, voice
, securityQuestions
, authenticatorToken
challengeOperationId
"string"
Challenge Operation ID (v1.0.1)
The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
type:
string
minLength: 6
maxLength: 48
pattern: ^[-a-zA-Z0-9$_]{6,48}$
challengePromptId
"string"
Challenge Prompt ID (v1.0.0)
The unique ID of a prompt (such as a security question) in a challenge factor.
type:
string
minLength: 1
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]+$
challengeSecurityQuestion
{
"id": "74699fa628911e762ea5",
"prompt": "What is your mother's maiden name?"
}
Challenge Security Question (v1.0.1)
A single security question within the questions
array of the challengeSecurityQuestions
Properties
Name | Description |
---|---|
Challenge Security Question (v1.0.1) | A single security question within the questions array of the challengeSecurityQuestions |
id | (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId .minLength: 1 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$ |
prompt | (required) The text prompt of this security question. format: text maxLength: 80 |
challengeSecurityQuestions
{
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
}
Challenge Security Questions (v1.0.1)
Describes a securityQuestions
challenge. This is omitted if the challenge type
is not securityQuestions
.
Properties
Name | Description |
---|---|
Challenge Security Questions (v1.0.1) | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions . |
questions | array: (required) The array of security questions. minItems: 1 maxItems: 8 items: object |
customerSession
{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e"
}
Customer Session Reference (v1.0.0)
Identifies an active session.
Properties
Name | Description |
---|---|
Customer Session Reference (v1.0.0) | Identifies an active session. |
sessionId | (required) The opaque, sensitive, session identifier used as an access token claim. maxLength: 128 |
institutionId
"TIBURON"
Institution ID (v1.1.0)
The unique immutable identifier of a financial institution.
type:
string
minLength: 2
maxLength: 8
pattern: ^[A-Z0-9_]{2,8}$
problemResponse
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists for the given account reference",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Problem Response (v0.4.1)
API problem or error response, as per RFC 7807 application/problem+json.
Properties
Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 7807 application/problem+json. |
type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" .format: uri-reference maxLength: 2048 |
title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type .format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048 |
id | The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.read-only format: date-time minLength: 20 maxLength: 30 |
problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
readOnlyResourceId
"string"
Read-only Resource Identifier (v1.0.1)
The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
type:
string
read-only
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
readOnlyTimestamp
"2021-10-30T19:06:04.250Z"
Read-Only Timestamp (v1.0.0)
A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time
UTC format: YYYY-MM-DDThh:mm:ss.sssZ
.
type:
string(date-time)
read-only
format: date-time
minLength: 20
maxLength: 30
requiredIdentityChallenge
{
"operationId": "createTransfer",
"challengeId": "0504076c566a3cf7009c",
"factors": [
{
"type": "sms",
"labels": [
"9876"
],
"id": "85c0ee5753fcd0b0953f"
},
{
"type": "voice",
"labels": [
"9876"
],
"id": "d089e10a80a8627df37b"
},
{
"type": "voice",
"labels": [
"6754"
],
"id": "10506ecf9d1c2ee00403"
},
{
"type": "email",
"labels": [
"an****nk@example.com",
"an****98@example.com"
],
"id": "e917d671cb2f030b56f1"
},
{
"type": "authenticatorToken",
"labels": [
"Acme fob"
],
"id": "fe6c452d7da0bbb4e407"
},
{
"type": "securityQuestions",
"securityQuestions": {
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
},
"id": "df33c6f88a37d6b3f0a6"
}
]
}
Required Challenge (v1.2.3)
A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired
. See the "Challenge API" for details.
Properties
Name | Description |
---|---|
Required Challenge (v1.2.3) | A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired . See the "Challenge API" for details. |
operationId | (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: ^[-a-zA-Z0-9$_]{6,48}$ |
challengeId | (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
factors | array: (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor.minItems: 1 maxItems: 8 items: object |
resourceId
"string"
Resource Identifier (v1.0.1)
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
type:
string
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
resumedCustomerSession
{
"sessionId": "login#1#6cf93423ff5647ad#4062217d6f04337fd31a76cea23ab7aad8bce93e71a9f0756daaf3cd1ae8579fea1601beb0521b7dbdac0ff4e",
"customerId": "9fa37c6c-2198",
"institutionId": "BOOIL"
}
Request to Resume or Create Customer Session (v1.0.0)
Request to resume a customer session or create a new one if the session has expired.
Properties
Name | Description |
---|---|
Request to Resume or Create Customer Session (v1.0.0) | Request to resume a customer session or create a new one if the session has expired. |
sessionId | (required) The opaque, sensitive, session identifier used as an access token claim. maxLength: 128 |
customerId | The opaque identifier of the customer. minLength: 6 maxLength: 38 pattern: ^\d+$ |
institutionId | The opaque, immutable identifier of the financial institution. minLength: 2 maxLength: 8 pattern: ^[A-Z0-9_]{2,8}$ |
@apiture/api-doc
3.1.0 on Fri Nov 03 2023 17:36:12 GMT+0000 (Coordinated Universal Time).