Currencies v0.4.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.

Operations related to monetary currencies (US Dollar, Euro, Japanese Yen, etc.) used in (international) financial transactions, such as international wire transfers.

This API provides the following features:

1. List available currencies for foreign exchange transactions.
2. Generate a currency conversion quote
3. Accept a currency conversion quote

Download OpenAPI Definition (YAML)

Base URLs:

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

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

Currencies

Banking Currencies

listCurrencies

Code samples

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

Return a list of currencies that may be used for foreign exchange transactions

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

Return a list of currencies that may be used for foreign exchange transactions, such as international wire transfers.

This operation is only allowed for banking customers/members who have entitlements to list currencies; the operation returns 403 Forbidden for others (with a forbidden problem type).

Example responses

200 Response

{
  "items": [
    {
      "code": "AUD",
      "label": "Australian dollar"
    },
    {
      "code": "BBD",
      "label": "Barbados dollar"
    },
    {
      "code": "BMD",
      "label": "Bermudian dollar"
    },
    {
      "code": "BRL",
      "label": "Brazilian real"
    },
    {
      "code": "CHF",
      "label": "Swiss franc"
    },
    {
      "code": "COP",
      "label": "Colombian peso"
    },
    {
      "code": "DKK",
      "label": "Danish krone"
    },
    {
      "code": "CAD",
      "label": "Canadian dollar"
    },
    {
      "code": "EUR",
      "label": "Euro"
    },
    {
      "code": "FJD",
      "label": "Fiji dollar"
    },
    {
      "code": "GBP",
      "label": "Pound sterling"
    },
    {
      "code": "HKD",
      "label": "Hong Kong dollar"
    },
    {
      "code": "INR",
      "label": "Indian rupee"
    },
    {
      "code": "JPY",
      "label": "Japanese yen"
    },
    {
      "code": "KRW",
      "label": "South Korean won"
    },
    {
      "code": "MXN",
      "label": "Mexican peso"
    },
    {
      "code": "NZD",
      "label": "New Zealand dollar"
    },
    {
      "code": "SEK",
      "label": "Swedish kronor"
    },
    {
      "code": "SGD",
      "label": "Singapore dollar"
    },
    {
      "code": "USD",
      "label": "United States dollar"
    }
  ]
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

generateCurrencyConversionQuote

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "sourceAmount": "1305.99"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/conversionQuotes',
{
  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/banking/conversionQuotes',
  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/banking/conversionQuotes',
  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/banking/conversionQuotes', params={

}, headers = headers)

print r.json()

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

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

Generate a currency conversion quote from US dollars to another currency.

POST https://api.apiture.com/banking/conversionQuotes

Generate a quote for converting from US dollars to a target currency. The request must contain either the sourceAmount in US dollars or the targetAmount in the targetCurrency. The response includes the computed targetAmount if sourceAmount was provided or the computed sourceAmount if targetAmount was provided. The response also includes exchange rate for US dollars to target currency and an date-time when the rate expires.

This operation is only allowed for banking customers/members who have entitlements to list currencies; the operation returns 403 Forbidden for others (with a forbidden problem type).

Body parameter

{
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "sourceAmount": "1305.99"
}

Parameters

Example responses

200 Response

{
  "settlementAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "vendorQuoteId": "54a0945f-5d7a",
  "sourceAmount": "1000.00",
  "targetAmount": "12250.00",
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "conversionRate": "1.225",
  "expiresAt": "2024-07-18T13:57:45.375Z",
  "signature": "eyJhbGciOiJFUzI"
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

acceptCurrencyConversionQuote

Code samples

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

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

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

};

fetch('https://api.apiture.com/banking/acceptedConversionQuotes',
{
  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/banking/acceptedConversionQuotes',
  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/banking/acceptedConversionQuotes',
  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/banking/acceptedConversionQuotes', params={

}, headers = headers)

print r.json()

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

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

Accept a currency conversion quote from US dollars to another currency.

POST https://api.apiture.com/banking/acceptedConversionQuotes

Accept a quote for converting from US dollars to a target currency.

Quotes accepted after the expiration timestamp are rejected.

This operation is only allowed for banking customers/members who have entitlements to list currencies; the operation returns 403 Forbidden for others (with a forbidden problem type).

Body parameter

{
  "signature": "eyJhbGciOiJFUzI"
}

Parameters

Example responses

200 Response

{
  "id": "3e8375b1-8c34",
  "vendorQuoteId": "54a0945f-5d7a",
  "settlementAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "sourceAmount": "1000.00",
  "targetAmount": "12250.00",
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "conversionRate": "1.225",
  "expiresAt": "2024-07-18T13:57:45.375Z"
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

acceptCurrencyConversionQuoteRequest

{
  "signature": "eyJhbGciOiJFUzI"
}

Accept Currency Conversion Quote (v1.1.0)

A request to accept a currency conversion quote between US dollars and a target currency for a specific target amount.

The signature is used to validate the quote being accepted.

Additional properties are not verified against the signature.

Properties

acceptedCurrencyConversionQuote

{
  "id": "3e8375b1-8c34",
  "vendorQuoteId": "54a0945f-5d7a",
  "settlementAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "sourceAmount": "1000.00",
  "targetAmount": "12250.00",
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "conversionRate": "1.225",
  "expiresAt": "2024-07-18T13:57:45.375Z"
}

Accepted Currency Conversion Quote (v2.0.0)

An accepted currency conversion quote. Accepted currency conversions represent a conversion rate between two currencies for a specific amount.

Properties

acceptedCurrencyConversionQuoteReference

{
  "id": "3e8375b1-8c34",
  "vendorQuoteId": "54a0945f-5d7a",
  "settlementAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "sourceAmount": "1000.00",
  "targetAmount": "12250.00",
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "conversionRate": "1.225",
  "expiresAt": "2024-07-18T13:57:45.375Z",
  "signature": "eyJhbGciOiJFUzI"
}

Accepted Currency Quote Reference (v1.1.0)

Representation of an accepted currency conversion quote.

Properties

accountLabel

"Checking *1008"

Account Label (v1.0.0)

The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber.

type: string(text)

format: text
minLength: 1
maxLength: 80

accountLocation

"internal"

Account Location (v1.1.0)

Indicates where an account is held

accountLocation strings may have one of the following enumerated values:

type: string

enum values: internal, external, outside, peer

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

conversionRate

"3456.78"

Conversion Rate (v1.0.0)

A currency conversion rate. The numeric value is represented as a decimal string so that it can be exact with no loss of precision.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(0|[1-9][0-9])\.[0-9]$"

currencies

{
  "items": [
    {
      "code": "AUD",
      "label": "Australian dollar"
    },
    {
      "code": "BBD",
      "label": "Barbados dollar"
    },
    {
      "code": "BMD",
      "label": "Bermudian dollar"
    },
    {
      "code": "BRL",
      "label": "Brazilian real"
    },
    {
      "code": "CHF",
      "label": "Swiss franc"
    },
    {
      "code": "COP",
      "label": "Colombian peso"
    },
    {
      "code": "DKK",
      "label": "Danish krone"
    },
    {
      "code": "CAD",
      "label": "Canadian dollar"
    },
    {
      "code": "EUR",
      "label": "Euro"
    },
    {
      "code": "FJD",
      "label": "Fiji dollar"
    },
    {
      "code": "GBP",
      "label": "Pound sterling"
    },
    {
      "code": "HKD",
      "label": "Hong Kong dollar"
    },
    {
      "code": "INR",
      "label": "Indian rupee"
    },
    {
      "code": "JPY",
      "label": "Japanese yen"
    },
    {
      "code": "KRW",
      "label": "South Korean won"
    },
    {
      "code": "MXN",
      "label": "Mexican peso"
    },
    {
      "code": "NZD",
      "label": "New Zealand dollar"
    },
    {
      "code": "SEK",
      "label": "Swedish kronor"
    },
    {
      "code": "SGD",
      "label": "Singapore dollar"
    },
    {
      "code": "USD",
      "label": "United States dollar"
    }
  ]
}

Currencies (v2.0.1)

A list of monetary currencies.

Properties

currency

{
  "code": "USD",
  "label": "United States dollar"
}

Currency (v2.0.0)

A Monetary Currency.

Properties

currencyCode

"str"

• (v1.0.0)*

A ISO 4217 currency code This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.

type: string(text)

format: text
minLength: 3
maxLength: 3
pattern: "^[A-Z]{3}$"

currencyConversionQuote

{
  "settlementAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "vendorQuoteId": "54a0945f-5d7a",
  "sourceAmount": "1000.00",
  "targetAmount": "12250.00",
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "conversionRate": "1.225",
  "expiresAt": "2024-07-18T13:57:45.375Z",
  "signature": "eyJhbGciOiJFUzI"
}

Currency Conversion Quote (v3.0.0)

Represents a quote for a currency conversion rate. A currency conversion quote consists of the a sourceAmount in US dollars, a target currency, the corresponding amount in a target currency, the currency conversion rate, and a date-time when the conversion rate expires.

The data in the response follows these conversion constraints:

• targetAmount = sourceAmount * conversionRate
• sourceAmount = targetAmount / conversionRate

If the request specified a target amount in the target currency, the sourceAmount may be rounded up to the next penny to ensure the full target amount is covered.

Properties

currencyConversionQuoteRequest

{
  "targetCurrency": {
    "code": "EUR",
    "label": "Euro"
  },
  "sourceAmount": "1305.99"
}

Currency Conversion Quote Request (v2.1.0)

A request to obtain a currency conversion quote for converting between US dollars and a target currency. The request must contain the targetCurrency and either a sourceAmount (the amount in US dollars) or a targetAmount (the amount in the target currency).

Properties

currencyConversionQuoteSignature

"eyJhbGciOiJFUzI"

Currency Conversion Quote Signature (v1.0.0)

A cryptographic digital signature representing a currency conversion quote. Use this signature to accept this currency conversion quote.

type: string

minLength: 1
maxLength: 2048
pattern: ".{1,2048}"

currencyReference

{
  "code": "USD",
  "label": "United States dollar"
}

Currency Reference (v1.0.0)

A reference for a monetary currency.

Properties

externalResourceId

"string"

External Resource Identifier (v1.1.0)

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

type: string(text)

read-only
format: text
minLength: 1
maxLength: 256

foreignExchangeMonetaryValue

"34.5678"

Foreign Exchange Monetary Value (v1.0.0)

A monetary value in a foreign currency, supporting only positive amounts. The numeric value is represented as a decimal string so that it can be exact with no loss of precision.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(0|[1-9][0-9]*)(\.[0-9]{1,4})?$"

monetaryValue

"3456.78"

Monetary Value (v1.1.1)

The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"

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

productType

"savings"

Product Type (v2.2.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, moneyMarket, healthSavings

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

transferAccountReference

{
  "id": "e821ce54-c715",
  "label": "Premiere Checking *6789",
  "type": "checking",
  "location": "internal"
}

Transfer Account Reference (v3.0.0)

A reference to a banking account used within an account to account transfer. This object may be set from an account's account.reference object.

Properties