Partner Integration Definitions Administration v0.4.1

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 allows Apiture Developer Portal (Dev Portal) administrators and manage partner integration definitions submitted by Developer Portal users. An integration definition defines a third party (fintech) integration into the Apiture Digital Banking platform. Initially, such integrations are for single-sign-on integrations (using SAML). This API allows administrators to review and approve/activate or reject integration definitions, or to deactivate integrations which Apiture or the financial institution suspects of fraudulent use or has a security risk or exposure.

Like client applications, an owner of an integration definition can invite other owners.

Owners may promote integration definitions (change from staged to live/active), disable them, and if there are no active instances, delete an integration definition.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

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

Partner Integration Definitions

Partner (Third Party) Integration Definitions

listPartnerIntegrationDefinitions

Code samples

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

GET https://api.apiture.com/devAdmin/integrationDefinitions HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of integrations

GET https://api.apiture.com/devAdmin/integrationDefinitions

Return a collection of integration definitions.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "ULTRA_PAY",
      "createdAt": "2021-10-30T19:06:04.250Z",
      "updatedAt": "2021-10-30T19:06:04.250Z",
      "partnerId": "3rdpartybank.com",
      "state": "active",
      "staged": false,
      "activeInstanceCount": 14,
      "description": "string",
      "availability": {
        "web": true,
        "mobile": true,
        "retail": true,
        "commercial": true,
        "institutions": "single"
      },
      "createdBy": "fintechdev_01",
      "assertionEncryptionSupported": true,
      "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
      "serviceProviderHostsMetadata": true
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

getPartnerIntegrationDefinition

Code samples

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

GET https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a representation of this integration

GET https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}

Return a representation of the integration definition.

Parameters

Example responses

200 Response

{
  "id": "FINTECH1_MODEL",
  "description": "Fintech1 Financial Modeling Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 Financial Modeling",
  "mobileLabel": "Fintech1 Financial Modeling",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer Id",
  "specificCustomerIdDescription": "Customer Id",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

Partner Integration Definition Actions

Actions on Integration Definitions

deactivatePartnerIntegrationDefinition

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Deactivate an integration definition.

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/inactive

Mark a disabled integration definition as inactive. This allows Apiture (perhaps on behalf of the financial institution) to prevent new integrations being created from an integration definition, for example, if there is suspicion of fraud or a security vulnerability. This sets the state to inactive.

Deactivated integration definitions are also unregistered in the System Integration Definitions API.

Only inactive, disabled, or active integration definition may be deactivated. Inactive integration definition can be activated again (by and administrator) with the activatePartnerIntegrationDefinition.

This operation is idempotent: it does nothing if the integration definition's state is already `inactive'.

Parameters

Example responses

200 Response

{
  "id": "FINTECH1_MODEL",
  "description": "Fintech1 Financial Modeling Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 Financial Modeling",
  "mobileLabel": "Fintech1 Financial Modeling",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer Id",
  "specificCustomerIdDescription": "Customer Id",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

activatePartnerIntegrationDefinition

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Activate an integration definition.

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/active

Mark an inactive or disabled integration definition as active. Note: Approving an integration definition is performed by activating a submitted integration definition. Only submitted, inactive, disabled, or active integration definition may be activated. This sets the state to active and also provisions the integration definition in the back end (using the System Integration Definitions API). This operation is idempotent: it does nothing if the integration definition's state is already `active'.

Parameters

Example responses

200 Response

{
  "id": "FINTECH1_MODEL",
  "description": "Fintech1 Financial Modeling Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 Financial Modeling",
  "mobileLabel": "Fintech1 Financial Modeling",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer Id",
  "specificCustomerIdDescription": "Customer Id",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

rejectPartnerIntegrationDefinition

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Reject an integration definition.

POST https://api.apiture.com/devAdmin/integrationDefinitions/{integrationDefinitionId}/rejected

Mark an inactive or disabled integration definition as rejected. Only submitted, inactive, disabled, or rejected integration definition may be marked as rejected. This sets the state to rejected and notifies the owners of the change. This operation is idempotent: it does nothing if the integration definition's state is already `rejected'.

Parameters

Example responses

200 Response

{
  "id": "FINTECH1_MODEL",
  "description": "Fintech1 Financial Modeling Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 Financial Modeling",
  "mobileLabel": "Fintech1 Financial Modeling",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer Id",
  "specificCustomerIdDescription": "Customer Id",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ]
}

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

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}$"

integrationDefinition

{
  "id": "FINTECH1_MODEL",
  "description": "Fintech1 Financial Modeling Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 Financial Modeling",
  "mobileLabel": "Fintech1 Financial Modeling",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer Id",
  "specificCustomerIdDescription": "Customer Id",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ]
}

Integration Definition (v4.0.0)

The definition of a third party integration.

Properties

integrationDefinitionAvailability

{
  "web": true,
  "mobile": true,
  "retail": true,
  "commercial": true,
  "institutions": "single"
}

Integration Definition Availability (v2.0.0)

Defines the run-time contexts in which this integration is available.

Properties

integrationDefinitionId

"ULTRA_PAY"

Integration Definition Identifier (v1.0.0)

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

type: string

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

integrationDefinitionInstitutionAvailability

"single"

Integration Definition Visibility (v1.0.0)

Integration Definition Visibility.

integrationDefinitionInstitutionAvailability strings may have one of the following enumerated values:

type: string

enum values: single, all

integrationDefinitionItem

{
  "id": "ULTRA_PAY",
  "description": "Fintech1 SSO Integration",
  "staged": false,
  "state": "active",
  "activeInstanceCount": 14,
  "label": "Fintech1 SSO Integration",
  "mobileLabel": "Fintech1 feature",
  "usesSpecificCustomerId": true,
  "specificCustomerIdLabel": "Customer ID",
  "specificCustomerIdDescription": "Unique Fintech1 Customer ID (GUID)",
  "availability": {
    "web": true,
    "mobile": true,
    "retail": true,
    "commercial": true,
    "institutions": "single"
  },
  "environmentId": "04833ea3-fbe0-43ac-95f8-188f59461ad5",
  "institutionId": "TCF",
  "partnerId": "3rdpartybank.com",
  "code": "createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {\n  integration.assertions.add('answer', '42');\n}",
  "audienceUrl": "https://my.audience.com/",
  "defaultRelayState": "RelStat123",
  "signatureAlgorithm": "RSA-SHA256",
  "digestAlgorithm": "SHA256",
  "encryptionAlgorithm": "AES256-GCM",
  "assertionEncryptionSupported": true,
  "serviceProviderMetadataUrl": "https://my.audience.com/saml/metadata.xml",
  "serviceProviderHostsMetadata": true,
  "targetMethod": "SAML-POST",
  "targetUrlTemplate": "https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D",
  "parameterSchema": {
    "type": "object",
    "properties": {
      "value1": {
        "description": "...",
        "type": "string",
        "format": "text",
        "minLength": 1,
        "maxLength": 200
      },
      "value2": {
        "description": "...",
        "type": "integer",
        "format": "int32",
        "minimum": 1,
        "maximum": 100
      },
      "value3": {
        "description": "...",
        "type": "string",
        "enum": [
          "a",
          "b",
          "c"
        ]
      }
    }
  },
  "owners": [
    "walter.white@example.com",
    "walter.grey@example.com",
    "walter.black@example.com"
  ],
  "createdAt": "2021-10-30T19:06:04.250Z",
  "updatedAt": "2021-10-30T19:06:04.250Z",
  "createdBy": "fintechdev_01"
}

Integration Definition Item (v3.0.0)

Integration definition item within collections/lists.

Properties