Debit Cards 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.

The Debit Card Management API provides operations for managing debit cards issued by a financial institution. This API allows card holders to perform various operations on their debit cards, linked to checking or savings accounts, such as monitoring usage.

Debit cards are activated through the activateDebitCard operation. Cards are activated by submitting the full card number of the new card and other additional card details for verification.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• 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

Debit Cards

Banking Debit Cards

listDebitCards

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards 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/accounts/{accountId}/debitCards',
{
  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/accounts/{accountId}/debitCards',
  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/accounts/{accountId}/debitCards',
  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/accounts/{accountId}/debitCards', params={

}, headers = headers)

print r.json()

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

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

Return a collection of debit cards

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards

Return a collection of debit cards for the current customer or member.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "cardholder": {
        "name": "Phil Duciary",
        "type": "primary"
      },
      "maskedAccountNumber": "*1000"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

getDebitCard

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId} 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/accounts/{accountId}/debitCards/{debitCardId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}',
  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/accounts/{accountId}/debitCards/{debitCardId}',
  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/accounts/{accountId}/debitCards/{debitCardId}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of this debit card

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}

Return the JSON representation of this debit card resource.

The full debit card number is not included in the response by default, for security reasons. Include the unmasked query parameter with a value of true to request that the response body includes the full debit card number. Such requests are auditable.

Parameters

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "state": "active",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false
  }
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

listDebitCardTransactions

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions 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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions");
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/accounts/{accountId}/debitCards/{debitCardId}/transactions", data)
    req.Header = headers

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

Return a collection of transaction summaries for a debit card resource

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions

Return a paginated collection of debit card transactions. The nextPage_url in the response is a pagination link.

Parameters

Example responses

200 Response

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/debitCards/d2d01f5e-f64a/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "items": [
    {
      "occurredOn": "2024-01-16",
      "description": "**MACYS1234",
      "amount": "52.05",
      "direction": "credit"
    },
    {
      "occurredOn": "2024-01-15",
      "description": "**MACYS1234",
      "amount": "-52.05",
      "direction": "debit"
    },
    {
      "occurredOn": "2024-01-13",
      "description": "**WALMART1337",
      "amount": "-49.85",
      "direction": "debit"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Debit Card Actions

Banking Debit Card Actions

activateDebitCard

Code samples

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

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/activated',
  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/accounts/{accountId}/debitCards/{debitCardId}/activated',
  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/accounts/{accountId}/debitCards/{debitCardId}/activated', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated");
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/accounts/{accountId}/debitCards/{debitCardId}/activated", data)
    req.Header = headers

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

Activate a Debit Card

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated

Activate a debit card.

This is an idempotent action; Activating a debit card with a state of active has no effect.

Body parameter

{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}

Parameters

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "state": "active",
  "cardholder": {
    "name": "Phil Duciary"
  },
  "maskedAccountNumber": "*1000"
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

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.0)

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

cardExpirationMonth

"st"

Card Expiration Month (v1.0.0)

The month portion of the card's MM/YY expiration in MM format.

type: string

minLength: 2
maxLength: 2
pattern: "^(0[1-9]|1[012])$"

cardExpirationYear

"st"

Card Expiration Year (v1.0.0)

The year portion of the year of the card's MM/YY expiration, in YY format (last two digits)

type: string

minLength: 2
maxLength: 2
pattern: "^\d{2}$"

cardSecurityCode

"stri"

Card Security Code (v1.0.0)

The Card Validation Code (CVC) or Card Validation Value (CVV) on a credit or debit card.

type: string

minLength: 3
maxLength: 4
pattern: "^\d{3,4}$"

cardholder

{
  "name": "Phil Duciary",
  "type": "primary",
  "address": {
    "address1": "1805 Tiburon Dr.",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28403"
  }
}

Cardholder (v1.0.0)

Information about the cardholder of an issued credit or debit card.

Properties

cardholderSummary

{
  "name": "Phil Duciary",
  "type": "primary"
}

Cardholder Summary (v1.0.0)

Summary information about the cardholder of an issued credit or debit card.

Properties

cardholderType

"primary"

Cardholder Type (v1.0.0)

The type of cardholder for this credit or debit card. For debit cards, this is always primary.

cardholderType strings may have one of the following enumerated values:

type: string

enum values: primary, secondary

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

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.0)

The monetary value representing a credit (positive amounts with no prefix or a + prefix) or debit (negative amounts with a - prefix). The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string

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

date

"2021-10-30"

Date (v1.0.0)

A date formatted in YYYY-MM-DD RFC 3339 date UTC format.

type: string(date)

format: date
minLength: 10
maxLength: 10

debitCard

{
  "id": "0399abed-fd3d",
  "state": "active",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false
  }
}

Debit Card (v3.0.0)

Representation of a debit card resource.

Properties

debitCardActivationRequest

{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}

Debit Card Activation Request (v1.0.0)

Representation used to activate a debit card.

Properties

debitCardAllows

{
  "activate": true
}

Debit Card Allows (v1.0.0)

Flags which indicate the permissions the current authorized user has on this debit card resource.

Properties

debitCardItem

{
  "id": "0399abed-fd3d",
  "state": "active",
  "cardholder": {
    "name": "Phil Duciary"
  },
  "maskedAccountNumber": "*1000"
}

Debit Card Summary Item (v3.0.0)

Summary representation of a debit card resource.

Properties

debitCardState

"active"

Debit Card State (v1.0.0)

The state of the debit card issued for the debit card account.

debitCardState strings may have one of the following enumerated values:

type: string

enum values: active, inactive

debitCardTransactionDirection

"debit"

Debit Card Transaction Direction (v1.0.0)

Distinguishes the direction of a debit card transaction.

debitCardTransactionDirection strings may have one of the following enumerated values:

type: string

enum values: debit, credit

debitCardTransactionItem

{
  "occurredOn": "2024-01-16",
  "description": "**MACYS1234",
  "amount": "-52.05",
  "direction": "debit"
}

Debit Card Transaction Item (v2.0.0)

Representation of a transaction resource in the debit card transactions collection.

Properties

debitCardTransactions

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/debitCards/d2d01f5e-f64a/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "items": [
    {
      "occurredOn": "2024-01-16",
      "description": "**MACYS1234",
      "amount": "52.05",
      "direction": "credit"
    },
    {
      "occurredOn": "2024-01-15",
      "description": "**MACYS1234",
      "amount": "-52.05",
      "direction": "debit"
    },
    {
      "occurredOn": "2024-01-13",
      "description": "**WALMART1337",
      "amount": "-49.85",
      "direction": "debit"
    }
  ]
}

Debit Card Transactions Collection (v2.0.0)

Collection of debit card transactions. The response object may contain the nextPage_url pagination link.

Properties

debitCards

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "cardholder": {
        "name": "Phil Duciary",
        "type": "primary"
      },
      "maskedAccountNumber": "*1000"
    }
  ]
}

Debit Cards (v2.0.0)

Collection of debit cards.

Properties

fullCardPersonalAccountNumber

"4242424242424242"

Full Card Personal Account Number (v1.0.0)

A full personal account number used in a credit or debit card. Spaces in requests are ignored. Spaces are omitted in responses.

type: string

minLength: 14
maxLength: 19
pattern: "^\d{1}[0-9 ]{12,17}\d{1}$"

maskedCardPersonalAccountNumber

"*1008"

Masked Card Personal Account Number (v1.0.1)

A masked card personal account number: an asterisk * followed by the last four digits of the full Personal Account Number (PAN).

type: string

minLength: 5
maxLength: 5
pattern: "^\*\d{4}$"

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

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