Apiture Digital Banking System User Integrations v0.2.2

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

This API provides functions for a web or mobile user to retrieve available integration instances, render the consent flow and retrieve create a Sign On Request for the current user.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (cookieAuth)
  • cookie parameter: secure.fx.sid.fxweb

Available Integrations

Third-party Integrations available to the user

listIntegrations

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/integrations \
  -H 'Accept: application/json'

GET https://api.apiture.com/banking/integrations HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

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

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

var headers = {
  'Accept':'application/json'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

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

}, headers = headers)

print r.json()

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

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

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

Return a list of integrations

GET https://api.apiture.com/banking/integrations

Return a collection of integrations available to the user and calling client.

Example responses

200 Response

{
  "items": [
    {
      "id": "ULTRA_PAY",
      "displayName": "Ultra Pay",
      "displayImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQAAAAA3bvkkAAAACklEQVR4AWNgAAAAAgABc3UBGAAAAABJRU5ErkJggg",
      "description": "string"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

Consent Flow

Actions related to required consent prior to using an SSO

processIntegrationStep

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/integrations/{integrationId}/processStep \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.apiture.com/banking/integrations/{integrationId}/processStep HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "stepNumber": 1,
  "accepted": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.apiture.com/banking/integrations/{integrationId}/processStep',
{
  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/banking/integrations/{integrationId}/processStep',
  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/banking/integrations/{integrationId}/processStep',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/banking/integrations/{integrationId}/processStep', params={

}, headers = headers)

print r.json()

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

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

Process integration consent step

POST https://api.apiture.com/banking/integrations/{integrationId}/processStep

Processes a consent step for the user and returns the next step. The initial call to this operation should be made with a stepNumber of 0.

Body parameter

{
  "stepNumber": 1,
  "accepted": true
}

Parameters

Example responses

201 Response

{
  "nextStepNumber": 1,
  "stepType": "consent",
  "content": "Please agree to the terms and conditions.",
  "contentType": "text/plain"
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

Sign On Request

Create Sign On Request for the current user

computeSignOnData

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData \
  -H 'Accept: application/json'

POST https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData',
{
  method: 'POST',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

Compute the single sign-on data for a user.

POST https://api.apiture.com/banking/integrations/{integrationId}/computeSignOnData

Return the SAML SSO data for the current user. This integration involves computation and is not stateless. Two subsequent calls for the same user will return different results, depending on the integration definition code, time, signature and encryption used.

Parameters

Example responses

201 Response

{
  "method": "SAML-POST",
  "targetUrl": "https://my.integration.com/saml",
  "samlData": "<saml:Assertion>...</saml:Assertion>"
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

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

challengeFactor

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

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

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

type: string

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

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

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

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

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

type: string

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

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

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

type: string

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

challengeSecurityQuestion

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

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

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

Challenge Security Questions (v1.0.1)

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

Properties

integrationId

"ULTRA_PAY"

Integration Instance Identifier (v1.0.0)

The unique, human-readable identifier for the integration instance.

type: string

minLength: 2
maxLength: 16
pattern: "^[A-Z0-9_]{2,16}$"

integrationItem

{
  "id": "ULTRA_PAY",
  "displayName": "Ultra Pay",
  "displayImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQAAAAA3bvkkAAAACklEQVR4AWNgAAAAAgABc3UBGAAAAABJRU5ErkJggg",
  "description": "Fintech1 SSO Integration"
}

Integration Instance Item (v1.0.0)

Integration instance item within collections/lists.

Properties

integrationSignOnData

{
  "method": "SAML-POST",
  "targetUrl": "https://my.integration.com/saml",
  "samlData": "<saml:Assertion>...</saml:Assertion>"
}

SAML SSO data (v1.0.0)

SAML SSO data for the current user to allow the client to initiate the SSO redirect.

Properties

integrationStepResponse

{
  "nextStepNumber": 1,
  "stepType": "consent",
  "content": "Please agree to the terms and conditions.",
  "contentType": "text/plain"
}

Integration Step (v1.0.0)

The data determining what the next step in the integration process is.

Properties

integrations

{
  "items": [
    {
      "id": "ULTRA_PAY",
      "displayName": "Ultra Pay",
      "displayImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQAAAAA3bvkkAAAACklEQVR4AWNgAAAAAgABc3UBGAAAAABJRU5ErkJggg",
      "description": "string"
    }
  ]
}

Integration collection (v1.0.0)

Collection of integrations.

Properties

problemResponse

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

Problem Response (v0.4.1)

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

Properties

processIntegrationStep

{
  "stepNumber": 1,
  "accepted": true
}

Integration Step Process Input (v1.0.0)

The fields required to process an integration step.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

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

type: string

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

readOnlyTimestamp

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

Read-Only Timestamp (v1.0.0)

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

type: string(date-time)

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

requiredIdentityChallenge

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

Required Challenge (v1.2.3)

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

Properties

resourceId

"string"

Resource Identifier (v1.0.1)

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

type: string

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