Organizations Administration v0.9.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 administrative applications to manage banking organizations. Organizations are companies or other entities such as non-profits, clubs, trusts, educational or government institutions, which have commercial accounts at a financial institution and use commercial (business) banking.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OAuth2 authentication (clientCredentials)
  • Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
  • Flow: clientCredentials
  • Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

Banking Organizations Administration

Administration of Banking Organizations

createBankingOrganization

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingOrganizations HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "name": "Expert Code Cleaners",
  "taxId": "112223333",
  "coreOrganizationId": "43b30335bd5582ec5c26",
  "contactName": "Max Peck",
  "lookupId": "ECC-2024",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/bankingOrganizations',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingOrganizations',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Create a new banking organization

POST https://api.apiture.com/bankingAdmin/bankingOrganizations

Create a new banking organization within the banking organizations collection.

Body parameter

{
  "name": "Expert Code Cleaners",
  "taxId": "112223333",
  "coreOrganizationId": "43b30335bd5582ec5c26",
  "contactName": "Max Peck",
  "lookupId": "ECC-2024",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Parameters

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "institutionId": "TIBURON",
  "referenceId": "677",
  "coreOrganizationId": "e1f7436f1ae95b626493",
  "taxId": "****7000",
  "name": "Expert Code Cleaners",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

getBankingOrganization

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Fetch a representation of this banking organization

GET https://api.apiture.com/bankingAdmin/bankingOrganizations/{bankingOrganizationId}

Return the JSON representation of this banking organization resource.

Parameters

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "institutionId": "TIBURON",
  "referenceId": "677",
  "coreOrganizationId": "e1f7436f1ae95b626493",
  "taxId": "****7000",
  "name": "Expert Code Cleaners",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

searchBankingOrganizations

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingOrganizationsSearches HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "taxId": "112223333"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/bankingOrganizationsSearches',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingOrganizationsSearches',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Find banking organizations by taxId or coreOrganizationId.

POST https://api.apiture.com/bankingAdmin/bankingOrganizationsSearches

Find banking organizations by taxId or coreOrganizationId. Since the taxId may be sensitive personally-identifiable data (for sole proprietorships, the organization taxId may be the owner's personal Social Security Number), this operation uses a "GET over POST" pattern - the search criteria are passed in the request body instead of via query parameters. The 200 OK response contains either a matching organization or no match.

Body parameter

{
  "taxId": "112223333"
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "name": "Expert Code Cleaners",
      "id": "0399abed-fd3d",
      "taxId": "112223333",
      "referenceId": "677",
      "coreOrganizationId": "7f9ce079ac658676d112",
      "institutionId": "TIBURON"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

address

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28403"
}

Address (v1.6.1)

A postal address that can hold a US address or an international (non-US) postal addresses.

Properties

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

bankingOrganization

{
  "id": "0399abed-fd3d",
  "institutionId": "TIBURON",
  "referenceId": "677",
  "coreOrganizationId": "e1f7436f1ae95b626493",
  "taxId": "****7000",
  "name": "Expert Code Cleaners",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Banking Organization (v2.0.0)

Representation of a banking organization resource.

Properties

bankingOrganizationAddresses

{
  "physical": {
    "address1": "1805 Tiburon Dr.",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  },
  "mailing": {
    "address1": "P.O. Box 1805",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Banking Organization Addresses (v1.0.1)

Postal addresses for a banking organization.

Properties

bankingOrganizationEmailAddresses

{
  "primary": "Max.Pike@example.com"
}

Banking Organization Email Addresses (v1.0.1)

The email addresses associated with a banking organization.

Properties

bankingOrganizationItem

{
  "id": "0399abed-fd3d",
  "name": "Expert Code Cleaners",
  "taxId": "112223333",
  "referenceId": "677",
  "coreOrganizationId": "7f9ce079ac658676d112",
  "institutionId": "TIBURON"
}

Banking Organization Item (v2.0.0)

Banking Organization Item.

Properties

bankingOrganizationPhoneNumbers

{
  "primary": "1-800-GET-APIS",
  "alternate": "910-555-0151",
  "fax": "910-555-0152"
}

Banking Organization Phone Numbers (v1.0.0)

The phone numbers associated with a banking organization.

Properties

bankingOrganizationSearchCriteria

{
  "taxId": "112223333"
}

Banking Organization Search Criteria (v1.0.0)

Search criteria for looking up banking organizations. The request must contain at least one of taxId or coreOrganizationId. If both are passed, the response is only those organizations that match both.

Properties

bankingOrganizationTaxId

"string"

• (v2.0.0)*

The tax identification number (TIN) or Employer Identification Number (EIN) of the business/organization. Note: If the organization is a sole proprietorship, the taxId is the proprietor's social security number. For security purposes, this value may be masked in responses. Use the ?unmasked=true query parameter to request that the response include unmasked data.

type: string(text)

format: text
minLength: 5
maxLength: 11

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

countryCode

"US"

Country Code (v1.0.0)

The ISO-3611 alpha-2 value for a country.

type: string

minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

extendedPhoneNumber

"+19105550155"

Extended Phone Number (v1.0.0)

A phone number with optional extension. Phone numbers are free-form strings and may include letters (such as '1-800-APITURE'), extensions (such as '919-555-1234 ext 34') or country code prefixes such as '+19105550155'.

type: string(extended-phone-number)

format: extended-phone-number
minLength: 5
maxLength: 20

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

matchingBankingOrganizations

{
  "items": [
    {
      "name": "Expert Code Cleaners",
      "id": "0399abed-fd3d",
      "taxId": "112223333",
      "referenceId": "677",
      "coreOrganizationId": "7f9ce079ac658676d112",
      "institutionId": "TIBURON"
    }
  ]
}

Matching Banking Organizations (v2.0.0)

Banking organizations which match the search criteria.

Properties

newBankingOrganization

{
  "name": "Expert Code Cleaners",
  "taxId": "112223333",
  "coreOrganizationId": "43b30335bd5582ec5c26",
  "contactName": "Max Peck",
  "lookupId": "ECC-2024",
  "addresses": {
    "physical": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Expert.Code.Cleaners@example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155"
  },
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

New Banking Organization (v2.0.0)

Request body to create a new banking organization.

Properties

newBankingOrganizationAddresses

{
  "physical": {
    "address1": "1805 Tiburon Dr.",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  },
  "mailing": {
    "address1": "P.O. Box 1805",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

New Banking Organization Addresses (v1.0.1)

Postal addresses for a new banking organization.

Properties

newBankingOrganizationEmailAddresses

{
  "primary": "Max.Pike@example.com"
}

New Banking Organization Email Addresses (v1.0.0)

The email addresses of a new banking organization.

Properties

newBankingOrganizationPhoneNumbers

{
  "primary": "1-800-GET-APIS",
  "alternate": "910-555-0151",
  "fax": "910-555-0152"
}

New Banking Organization Phone Numbers (v1.0.0)

The phone numbers associated with a new banking organization.

Properties

postalCode

"20521"

Postal code (v1.0.0)

The postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4.

type: string

minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

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

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

referenceId

"string"

• (v1.0.0)*

A short, numeric ID value that allows administrative application users to reference and look up customers.

type: string

minLength: 2
maxLength: 12
pattern: "^[0-9]{2,12}$"

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