Disclosures Administration 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 Banking Disclosures API is an admin API that manages the disclosure documents for financial institution that a user may consent to. Disclosures may be assigned to different products within the Banking Products API or associated with the institution (such as a privacy policy or electronic use consent). A disclosure document resource holds the URI of a target document (typically, a PDF document). Each disclosure also has a type, such as privacyPolicy or productTermsAndConditions or electronicConsent, which indicates the target document's type and purpose. They also include a context, which indicates the scope of the target document. The disclosure documents are scoped to a single context each. The allProducts context is used for when the disclosure document applies to all products. If the disclosure document only applies to a subset of products, the specificProducts context is used, and the products are listed in the products The institution context is used for disclosure documents related to the relationship between a financial institution and their customers. The disclosure resource also holds the document's media type, specific document revision identification string, and the time stamp of when the document was last modified.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. 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

Banking Disclosures

Banking Disclosures

listBankingDisclosures

Code samples

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

GET https://api.apiture.com/bankingAdmin/disclosures 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/bankingAdmin/disclosures',
{
  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/bankingAdmin/disclosures',
  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/bankingAdmin/disclosures',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

Return a collection of banking disclosures

GET https://api.apiture.com/bankingAdmin/disclosures

Return a collection of banking disclosures.

Example responses

200 Response

{
  "items": [
    {
      "id": "86aac4ee-b695",
      "title": "Terms and Conditions for 180 Day CD Accounts",
      "context": "specificProducts",
      "type": "termsAndConditions",
      "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
      "contentType": "application/pdf",
      "order": 23,
      "revisionId": "440AEC4",
      "products": [
        {
          "id": "9d8f45ef9be307e1405d",
          "customerType": "personal",
          "type": "cd",
          "coreType": "CD",
          "code": "180D_CDA",
          "label": "180 Day CD",
          "description": "180-day Certificate of Deposit account that earns 1.60%"
        }
      ],
      "createdAt": "2022-05-01T09:54:23.023Z",
      "updatedAt": "2022-05-01T12:31:15.108Z",
      "updatedBy": {
        "id": "0399abed-fd3d",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "title": "Privacy Policy for CD Accounts",
      "context": "specificProducts",
      "type": "privacyDocument",
      "url": "http://cdn.apiture.com/TCF/product-documents/P01CD/privacyPolicy-2023-05.pdf",
      "contentType": "application/pdf",
      "order": 25,
      "revisionId": "1.55.0",
      "products": [
        {
          "id": "9d8f45ef9be307e1405d",
          "customerType": "personal",
          "type": "cd",
          "coreType": "CD",
          "code": "180D_CDA",
          "label": "180 Day CD",
          "description": "180-day Certificate of Deposit account that earns 1.60%"
        }
      ],
      "createdAt": "2022-05-05T08:16:44.019Z",
      "updatedAt": "2022-05-05T08:20:19.650Z",
      "updatedBy": {
        "id": "2802fc2f-c178",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings"
      }
    }
  ]
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

getBankingDisclosure

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: string' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string

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

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

};

fetch('https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}");
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"},
        "If-None-Match": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch a representation of this banking disclosure

GET https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}

Return the JSON representation of this banking disclosure resource.

Parameters

Example responses

200 Response

{
  "id": "86aac4ee-b695",
  "title": "Terms and Conditions for 180 Day CD Accounts",
  "context": "specificProducts",
  "type": "termsAndConditions",
  "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
  "contentType": "application/pdf",
  "order": 23,
  "revisionId": "440AEC4",
  "products": [
    {
      "id": "9d8f45ef9be307e1405d",
      "customerType": "personal",
      "type": "cd",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%"
    }
  ],
  "createdAt": "2022-05-01T09:54:23.023Z",
  "updatedAt": "2022-05-01T12:31:15.108Z",
  "updatedBy": {
    "id": "2802fc2f-c178",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings"
  }
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

patchBankingDisclosure

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId} \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "order": 10
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'If-Match':'string',
  'Authorization':'Bearer {access-token}'

};

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

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'If-Match':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'application/json',
  'If-Match' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'application/json',
  'If-Match': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/merge-patch+json"},
        "Accept": []string{"application/json"},
        "If-Match": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update this banking disclosure

PATCH https://api.apiture.com/bankingAdmin/disclosures/{bankingDisclosureId}

Perform a partial update of this banking disclosure as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "order": 10
}

Parameters

Example responses

200 Response

{
  "id": "86aac4ee-b695",
  "title": "Terms and Conditions for 180 Day CD Accounts",
  "context": "specificProducts",
  "type": "termsAndConditions",
  "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
  "contentType": "application/pdf",
  "order": 23,
  "revisionId": "440AEC4",
  "products": [
    {
      "id": "9d8f45ef9be307e1405d",
      "customerType": "personal",
      "type": "cd",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%"
    }
  ],
  "createdAt": "2022-05-01T09:54:23.023Z",
  "updatedAt": "2022-05-01T12:31:15.108Z",
  "updatedBy": {
    "id": "2802fc2f-c178",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings"
  }
}

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

bankingDisclosure

{
  "id": "86aac4ee-b695",
  "title": "Terms and Conditions for 180 Day CD Accounts",
  "context": "specificProducts",
  "type": "termsAndConditions",
  "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
  "contentType": "application/pdf",
  "order": 23,
  "revisionId": "440AEC4",
  "products": [
    {
      "id": "9d8f45ef9be307e1405d",
      "customerType": "personal",
      "type": "cd",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%"
    }
  ],
  "createdAt": "2022-05-01T09:54:23.023Z",
  "updatedAt": "2022-05-01T12:31:15.108Z",
  "updatedBy": {
    "id": "2802fc2f-c178",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings"
  }
}

Banking Disclosure (v1.0.0)

Representation of banking disclosure resources.

Properties

bankingDisclosureContext

"specificProducts"

Banking Disclosure Context (v1.0.0)

The contextual scope of the disclosure document.

bankingDisclosureContext strings may have one of the following enumerated values:

type: string

enum values: specificProducts, allProducts, institution

bankingDisclosureDocumentType

"termsAndConditions"

Banking Disclosure Document Type (v1.0.0)

The type of disclosure document.

bankingDisclosureDocumentType strings may have one of the following enumerated values:

type: string

enum values: termsAndConditions, electronicConsent, digitalBankingAgreement, privacyDocument, other

bankingDisclosureItem

{
  "id": "86aac4ee-b695",
  "title": "Terms and Conditions for 180 Day CD Accounts",
  "context": "specificProducts",
  "type": "termsAndConditions",
  "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
  "contentType": "application/pdf",
  "order": 23,
  "revisionId": "20230601",
  "products": [
    {
      "id": "9d8f45ef9be307e1405d",
      "customerType": "personal",
      "type": "cd",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%"
    }
  ],
  "createdAt": "2022-05-01T09:54:23.023Z",
  "updatedAt": "2022-05-01T12:31:15.108Z",
  "updatedBy": {
    "id": "2802fc2f-c178",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings"
  }
}

Banking Disclosure Item (v1.0.0)

Summary representation of a banking disclosure resource in banking disclosure collections.

Properties

bankingDisclosurePatch

{
  "order": 10
}

Banking Disclosure Patch (v1.1.0)

Representation of a patch to a banking disclosure resource. The url and contentType fields are implicitly paired. If one is included in the patch, the other must be included as well.

Properties

bankingDisclosures

{
  "items": [
    {
      "id": "86aac4ee-b695",
      "title": "Terms and Conditions for 180 Day CD Accounts",
      "context": "specificProducts",
      "type": "termsAndConditions",
      "url": "http://cdn.apiture.com/TCF/product-documents/P003CD180/termsAndConditions-2023-05.pdf",
      "contentType": "application/pdf",
      "order": 23,
      "revisionId": "440AEC4",
      "products": [
        {
          "id": "9d8f45ef9be307e1405d",
          "customerType": "personal",
          "type": "cd",
          "coreType": "CD",
          "code": "180D_CDA",
          "label": "180 Day CD",
          "description": "180-day Certificate of Deposit account that earns 1.60%"
        }
      ],
      "createdAt": "2022-05-01T09:54:23.023Z",
      "updatedAt": "2022-05-01T12:31:15.108Z",
      "updatedBy": {
        "id": "0399abed-fd3d",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "title": "Privacy Policy for CD Accounts",
      "context": "specificProducts",
      "type": "privacyDocument",
      "url": "http://cdn.apiture.com/TCF/product-documents/P01CD/privacyPolicy-2023-05.pdf",
      "contentType": "application/pdf",
      "order": 25,
      "revisionId": "1.55.0",
      "products": [
        {
          "id": "9d8f45ef9be307e1405d",
          "customerType": "personal",
          "type": "cd",
          "coreType": "CD",
          "code": "180D_CDA",
          "label": "180 Day CD",
          "description": "180-day Certificate of Deposit account that earns 1.60%"
        }
      ],
      "createdAt": "2022-05-05T08:16:44.019Z",
      "updatedAt": "2022-05-05T08:20:19.650Z",
      "updatedBy": {
        "id": "2802fc2f-c178",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings"
      }
    }
  ]
}

Banking Disclosure Collection (v1.0.1)

Collection of banking disclosures. The items in the collection are ordered in the items array.

Properties

bankingProductFields

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Banking Product Fields (v1.1.1)

Common fields of the product resource used to build other model schemas.

Properties

bankingProductItem

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "180-day Certificate of Deposit account that earns 1.60%",
  "id": "9d8f45ef9be307e1405d",
  "customerType": "personal"
}

Product Item (v1.1.1)

Summary representation of a product resource in products collections. To fetch the full representation of this product, use the getBankingProduct operation, passing this item's id field as the bankingProductId path parameter.

Properties

challengeFactor

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

Challenge Factor (v1.2.1)

An 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

contentType

"application/pdf"

• (v1.0.0)*

The media type of a file.

type: string

minLength: 8
maxLength: 191
pattern: ^[-a-z0-9]{4,48}/[-+a-z0-9.]{3,142}$

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

productCustomerType

"personal"

Product Customer Type (v1.0.0)

Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).

productCustomerType strings may have one of the following enumerated values:

type: string

enum values: personal, business, both

productReference

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Product Reference (v2.2.1)

A reference to a banking product.

Properties

productType

"savings"

Product Type (v2.0.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

type: string

enum values: savings, checking, cd, ira, loan, creditCard

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