Customers Administration v0.48.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.

An API for managing the financial institution's customers, also known as members at credit unions. This API only accesses customers enrolled in digital banking. It cannot access financial institution customers that are only in the banking core (for example, those who only bank at the branch or via ATMs).

This API provides these operations:

getBankingCustomers allows an application to fetch information about one or more customers enrolled in Apiture Digital Banking.
getBankingCustomer allows an application to fetch detailed information about a customer (person) enrolled in Apiture Digital Banking.
createBankingCustomer allows an application to create a new banking customer and their Apiture Digital Banking login credentials.
patchBankingCustomer allows an application to edit a banking customer.
deleteBankingCustomer allows an application to delete a pending banking customer.
createCandidateBankingCustomer allows an application to stage new customer's profile information for an identity provider (IdP) managed by the financial institution, in order to link a Apiture banking customer to the financial institution's systems or to create a new banking customer. This allows the IdP sign up flow to use this previously collected banking customer profile data.
getCandidateBankingCustomer to fetch the data created by createCandidateBankingCustomer
markBankingCustomerIdentityAsMigrated to mark a customer identity as migrated from the financial institution identity provider into Apiture Digital Banking
getInvitedCandidateBankingCustomer to fetch the candidate customer by the customer invitation ID
deleteCandidateBankingCustomer to delete a candidate banking customer and the invitation associated with the candidate customer..
convertCandidateToBankingCustomer Called when the financial institution's identity provider has completed customer registration; convert the candidate customer to a banking customer.
listActiveBankingCustomerSessions to list all active customer sessions in the identity provider.
terminateOpenIdConnectBankingCustomerSession terminate a customer session as part of a OpenID Connect Logout Request.
searchBankingCustomers to search for existing banking customers by one or more identifiers.
validateBankingCustomerAuthentication for a secure client to verify customer credentials as part of a customer/banking provider migration.

Authenticated Access

The operations in this API require an OAuth2 access token, which may either be obtained via the Client Credentials flow (for use by secure headless applications) or by Authorization Code Flow by financial institution (FI) administrative users who authenticate with the financial institution's workforce identity provider. Non-FI partner organizations may only use Client Credentials.

Accessing Customers for a Specific Financial Institution

The access token is associated with a unique Client ID. Client IDs are normally associated with a specific financial institution. If the Client ID is not tied to a specific institution, the client must provide the Institution-Id request header parameter to identify the target institution where the customers and customers are held. This header is ignored otherwise.

API Identities

This API is designed to be called from the following identity types:

Financial institution operator
Secure service client

Download OpenAPI Definition (YAML)

Base URLs:

https://api.apiture.com/bankingAdmin

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

Scope	Scope Description
`bankingAdmin/read`	Read a wide variety of banking and other financial institution and customer data.
`bankingAdmin/write`	Write a wide variety of banking and other financial institution and customer data.
`identity/read`	Read access to user/customer/member identity-related resources.
`identity/write`	Read, write, and delete access to user/customer/member identity-related resources.
`customerRegistrations/read`	Read access to user, customer or member registration/enrollment/identity related resources.
`customerRegistrations/write`	Read, write, and delete access to user, customer or member registration/enrollment/identity related resources.
`bankingAdmin/writeUsername`	Ability to update a new customer's username.

Customers Administration

getBankingCustomers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698 \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698 HTTP/1.1
Host: api.apiture.com
Accept: application/json
Institution-Id: TIBURON

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

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers',
  method: 'get',
  data: '?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/bankingCustomers',
  params: {
  'customers' => 'array[string]'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/bankingCustomers', params={
  'customers': [
  "b0002de89f878411c5f8",
  "29eeb140c5ad8743507d",
  "0afd7e9dba0a838f85d7",
  "120d3b696d5737cc5413",
  "75a7fce04e741365c698"
]
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698");
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"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

List banking customers at a financial institution.

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

Return banking customer (member) details for a selected list of banking customer IDs.

Parameters

Parameter	Description
`Institution-Id` `in: header`	`institutionId` The unique identifier of the financial institution. `minLength: 2` `maxLength: 8` `pattern: "^[A-Z0-9_]{2,8}$"`
`customers` `in: query`	`array[string]` (required) Fetch customer details for the customers identified in this comma-separated list of banking customer IDs. `unique items` `minItems: 1` `maxItems: 32` `comma-delimited` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`unmasked` `in: query`	`boolean` When requesting customer details, the sensitive personally identifiable information (PII) about each customer is masked for security reasons. Include this query parameter with a value of `true` to request that the response body includes the full PII. Such requests are auditable. The following data fields are among those that are masked by default: phone numbers, email addresses, login user name, date of birth. `default: false`

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "coreCustomerId": "12299292",
      "username": "peck_plumbing",
      "name": "Peck Plumbing",
      "type": "commercial",
      "state": "enabled",
      "commercial": {
        "contactName": "Max Peck"
      },
      "contactCard": {
        "addresses": {
          "primary": {
            "address1": "1805 Tiburon Dr.",
            "address2": "Building 14, Suite 1500",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          },
          "mailing": {
            "address1": "P.O. Box 0000000",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          }
        },
        "emailAddresses": {
          "primary": "max@example.com",
          "secondary": "plank_plumbing@example.com"
        },
        "phoneNumbers": {
          "primary": "+19105555512",
          "mobile": "9105555513",
          "alternate": "+19105555514",
          "fax": "+19105555514"
        }
      },
      "identityChallengeFactors": {
        "email": {
          "primary": true,
          "secondary": false
        },
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        },
        "voice": {
          "primary": false,
          "secondary": true,
          "mobile": true,
          "alternate": true
        }
      },
      "employee": "notAnEmployee",
      "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
      "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
      "createdAt": "2020-05-04T12:37:08.375Z",
      "enrolledAt": "2020-05-04T12:37:08.375Z"
    }
  ]
}

Responses

Status	Description
200	OK
	OK. The response contains the customer information for the requested customer IDs.
	Schema: `bankingCustomerList`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidCustomerIds/v1.0.0
One or more customer IDs are invalid and do not correspond to customers. Remediation: Remove the invalid customer IDs from the request and try again. The attributes object in the error may have the properties defined for invalidCustomerIds.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createBankingCustomer

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingCustomers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Apiture-Viewer-Country: US
Apiture-Viewer-Address: string

const fetch = require('node-fetch');
const inputBody = '{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "password": "Peter-Piper-picked-a-peck-plumber-7771",
  "taxId": "112223333",
  "name": "Max Peck",
  "nickname": "Max",
  "alternateName": "Maxwell Peck",
  "type": "commercial",
  "birthdate": "2002-10-31",
  "enrollmentState": "enrolled",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "identitySource": "digitalBanking"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Apiture-Viewer-Country':'US',
  'Apiture-Viewer-Address':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers',
{
  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',
  'Apiture-Viewer-Country':'US',
  'Apiture-Viewer-Address':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers',
  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',
  'Apiture-Viewer-Country' => 'US',
  'Apiture-Viewer-Address' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Apiture-Viewer-Country': 'US',
  'Apiture-Viewer-Address': 'string',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

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

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

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

Create a banking customer in Apiture Digital Banking

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

Create a banking customer in Apiture Digital Banking.

The request must include the username and password if using Apiture identity provider, or subjectId if using the financial institution's own identity provider. See the institutionConfiguration.identityProvider value in the response from the getInstitutionConfiguration in the Institutions API.

Body parameter

{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "password": "Peter-Piper-picked-a-peck-plumber-7771",
  "taxId": "112223333",
  "name": "Max Peck",
  "nickname": "Max",
  "alternateName": "Maxwell Peck",
  "type": "commercial",
  "birthdate": "2002-10-31",
  "enrollmentState": "enrolled",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "identitySource": "digitalBanking"
}

Parameters

Parameter	Description
`Apiture-Viewer-Country` `in: header`	`countryCode` For operations which support this request header, this header's value is the ISO-3611 alpha-2 2-letter country code of the location of the person using the application which is invoking the API operation. For some service configurations, the operation may return a 403 Forbidden response if the financial institution restricts the activity from the country. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`Apiture-Viewer-Address` `in: header`	`ipAddressAndPort` For operations which support this request header, this header's value is the IP address of the person using the application which is invoking the API operation, and the source port of the request. `pattern: "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}:[0-9]{1,5}$\|^\\[?[A-Fa-f0-9:]+\\]?:[0-9]{1,5}$\|^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$\|^\\[?[A-Fa-f0-9:]+\\]?$"`
`body`	`newBankingCustomer`

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Responses

Status	Description
201	Created
	Created.
	Schema: `bankingCustomer`
Header	`Location` `string` `uri-reference`
	The URI of the new banking customer.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/geoRestrictionViolation/v1.0.0
The API request originated in a restricted country or region. Remediation: The end user must be located in a non-restricted country or region.

Schema: problemResponse

Status Description

409 Conflict

Conflict. A new customer cannot be created, as there is already a matching customer, or this operation is not supported for this financial institution's configuration.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/customerAlreadyExists/v1.0.0
A customer with this key identification data (taxId and/or coreCustomerId) already exists. Remediation: Try again with different key data.
https://production.api.apiture.com/errors/customerIsLocked/v1.0.0
The financial institution has locked new banking activity for the given customer taxId. Remediation: Inform the customer that the financial institution has locked new banking activity.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidCandidateCustomer/v1.0.0
The supplied profile data is invalid. Remediation: Provide valid customer profile data.
https://production.api.apiture.com/errors/passwordPolicyViolation/v1.0.0
The supplied password violates the financial institution's password policies. Remediation: Have the customer provide a password that satisfies the financial institution's password policies.
https://production.api.apiture.com/errors/usernamePolicyViolation/v1.0.0
The supplied username violates the financial institution's username policies. Remediation: Have the customer provide a username that satisfies the financial institution's username policies.
https://production.api.apiture.com/errors/customerIdentityRequired/v1.0.0
The request must include the subjectId and omit username and password when using the financial institution's own identity provider. Remediation: Include the customer's subjectId in the request.
https://production.api.apiture.com/errors/customerCredentialsRequired/v1.0.0
The request must include the username and password and omit subjectId when using the Apiture provided identity provider. Remediation: Include the customer's username and password in the request.
https://production.api.apiture.com/errors/usernameAndPasswordRequiredForDigitalBankingIdentitySource/v1.0.0
The identitySource was digitalBanking but username or password was not included. Remediation: When identitySource is digitalBanking, include values for username and password.
https://production.api.apiture.com/errors/subjectIdRequiredForExternalIdentitySource/v1.0.0
The identitySource was external but subjectId was not included. Remediation: When identitySource is external, include a value for subjectId.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getBankingCustomer

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Fetch a representation of this banking customer

GET https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}

Return the JSON representation of this banking customer resource.

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` Sensitive personally identifiable data (such as the `taxId`, `birthdate`) is masked or not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes (unmasked) sensitive data. `default: false`
`bankingCustomerId` `in: path`	`resourceId` (required) The unique identifier of this banking customer. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `bankingCustomer`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such banking customer resource at the specified `{bankingCustomerId}`.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchBankingCustomer

Code samples

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

PATCH https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "birthdate": "2002-10-31",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "subjectId": "dac94134-248f97f23ec6",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

};

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Update this banking customer

PATCH https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}

Perform a partial update of this banking customer 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.

If the request includes the username property, the calling client application must have the bankingAdmin/writeUsername client credentials authorization scope. If the client authorization is missing this scope, the operation returns a 403 status code.

Body parameter

{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "birthdate": "2002-10-31",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "subjectId": "dac94134-248f97f23ec6",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Parameters

Parameter	Description
`body`	`bankingCustomerPatch` (required) The fields to update within the banking customer. `Unevaluated Properties: false`
`bankingCustomerId` `in: path`	`resourceId` (required) The unique identifier of this banking customer. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `bankingCustomer`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such banking customer resource at the specified `{bankingCustomerId}`.
	Schema: `problemResponse`

Status Description

409 Conflict

Conflict. The request conflicts with the state of the application.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/conflict/v1.0.0
The request could not be completed due to a conflict with the current state of the target resource. Remediation: Try another operation that is allowed.
https://production.api.apiture.com/errors/customerAlreadyExists/v1.0.0
A customer with this key identification data (taxId and/or coreCustomerId) already exists. Remediation: Try again with different key data.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.
https://production.api.apiture.com/errors/mailingAddressIsImmutable/v1.0.0
This financial institution disallows updating a customer's mailing address. Remediation: Remove the mailing address from the update request.
https://production.api.apiture.com/errors/passwordPolicyViolation/v1.0.0
The supplied password violates the financial institution's password policies. Remediation: Have the customer provide a password that satisfies the financial institution's password policies.
https://production.api.apiture.com/errors/usernamePolicyViolation/v1.0.0
The supplied username violates the financial institution's username policies. Remediation: Have the customer provide a username that satisfies the financial institution's username policies.
https://production.api.apiture.com/errors/customerIdentityRequired/v1.0.0
The request must include the subjectId and omit username and password when using the financial institution's own identity provider. Remediation: Include the customer's subjectId in the request.
https://production.api.apiture.com/errors/customerCredentialsRequired/v1.0.0
The request must include the username and password and omit subjectId when using the Apiture provided identity provider. Remediation: Include the customer's username and password in the request.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

deleteBankingCustomer

Code samples

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

DELETE https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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/problem+json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Delete a pending banking customer.

DELETE https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}

Delete a pending banking customer. If the customer is not in a pendingApplicant or pendingEnrollment state, the operation fails with a 409 Conflict response.

Parameters

Parameter	Description
`bankingCustomerId` `in: path`	`resourceId` (required) The unique identifier of this banking customer. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

401 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/unauthorized/v1.0.0",
  "title": "Unauthorized",
  "status": 401,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "The request lacks valid authentication credentials",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

Status	Description
204	No Content
	Deleted, No Content.

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such banking customer resource at the specified `{bankingCustomerId}`.
	Schema: `problemResponse`

Status	Description
409	Conflict
	Conflict. The banking customer is enrolled in digital banking and may not be deleted. Only delete customers that are in a `pendingApplicant` or `pendingEnrollment` state.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

searchBankingCustomers

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingCustomerSearches 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/bankingCustomerSearches',
{
  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/bankingCustomerSearches',
  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/bankingCustomerSearches',
  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/bankingCustomerSearches', params={

}, headers = headers)

print r.json()

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

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

Find banking customers by search criteria.

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

Find banking customers by one or more identifiers, such as taxId or coreCustomerId. Since the taxId is sensitive personally-identifiable data, 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 customer or no match.

This operation only searches for people, not businesses which may hold business accounts.

Body parameter

{
  "taxId": "112223333"
}

Parameters

Parameter	Description
`enrollmentState` `in: query`	`array[string]` Include in the response only customer's whose `enrollmentState` matches a value in this pipe-delimited list. `unique items` `minItems: 1` `maxItems: 3` `pipe-delimited` items: `string` » enum values: `pendingApplicant`, `pendingEnrollment`, `enrolled`
`unmasked` `in: query`	`boolean` When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the full account number. Such requests are auditable. `default: false`
`ignoreUsernameCase` `in: query`	`boolean` By default, the comparison of the `username` in the `bankingCustomerSearchCriteria` request body is case sensitive. Pass `?ignoreUsernameCase=true` to request that the comparison be case insensitive. For example, searching for customers by `"username": "john.deere"` matches the customer with a `username` of `"john.deere"`, but does not match customers whose `username` is `"John.Deere"` or `"John.DEERE"`. Use `?ignoreUsernameCase=true` to compare the `username` while ignoring case differences. When `true`, searching for `"username": "john.deere"` also matchs matching customers with username `"John.Deere"` and `"John.DEERE"`.
`body`	`bankingCustomerSearchCriteria`

Example responses

200 Response

{
  "items": [
    {
      "id": "3a6b72311531ffc64d42",
      "coreCustomerId": "0964e98c6edeab9dc098",
      "username": "peck_plumbing",
      "name": "Max Peck",
      "type": "retail",
      "state": "enabled",
      "scope": "person",
      "taxId": "112223333",
      "enrollmentState": "enrolled",
      "referenceId": "1499",
      "institutionId": "TIBURON",
      "emailAddresses": {
        "primary": "Max.Pike@example.com",
        "secondary": "MaxwellPike@me.example.com"
      },
      "phoneNumbers": {
        "primary": "+19105550155",
        "mobile": "+19105550150"
      },
      "authenticationChallengeFactors": [
        {
          "type": "email",
          "email": {
            "primary": true,
            "secondary": false
          }
        },
        {
          "type": "sms",
          "sms": {
            "primary": false,
            "secondary": false,
            "mobile": true,
            "alternate": false
          }
        },
        {
          "type": "voice",
          "voice": {
            "primary": false,
            "secondary": false,
            "mobile": true,
            "alternate": false
          }
        }
      ]
    }
  ]
}

Responses

Status	Description
200	OK
	OK. The search was processed. The response body contains matching customers, or an empty array if no matching customers are found.
	Schema: `matchingBankingCustomers`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.
https://production.api.apiture.com/errors/missingCustomerSearchCriteria/v1.0.0
The search request must include at least one of the search criteria. Remediation: Repeat the operation, passing at least one of the search criteria.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createCandidateBankingCustomer

Code samples

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

POST https://api.apiture.com/bankingAdmin/candidateCustomers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Apiture-Viewer-Country: US
Apiture-Viewer-Address: string

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "name": "Phil Duciary",
  "alternateName": "Philip K. Duciary",
  "coreCustomerId": "3392c022c74aad2bb8e5",
  "nickname": "Max",
  "enrollmentState": "enrolled",
  "type": "retail",
  "middleName": "K.",
  "contactCard": {
    "phoneNumbers": {
      "primary": "+1919555-1234"
    },
    "emailAddresses": {
      "primary": "phil.duciary@example.com"
    }
  },
  "taxId": "111223333",
  "birthdate": "2003-08-24",
  "employee": "notAnEmployee",
  "electronicDocumentElectionDefault": true,
  "electronicStatementElectionDefault": true,
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Apiture-Viewer-Country':'US',
  'Apiture-Viewer-Address':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/candidateCustomers',
{
  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',
  'Apiture-Viewer-Country':'US',
  'Apiture-Viewer-Address':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/candidateCustomers',
  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',
  'Apiture-Viewer-Country' => 'US',
  'Apiture-Viewer-Address' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Apiture-Viewer-Country': 'US',
  'Apiture-Viewer-Address': 'string',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

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

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

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

Save a candidate customer's profile data if a matching customer does not yet exist.

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

Save the the supplied customer profile data as a candidate customer to be added to the financial institution's identity provider if the customer does not already exist. If an existing candidate customer with a matching taxId, core customer ID, or email is found, this operation replaces the data of the previously stored candidate customer. Any existing invitations for the candidate customer are invalidated and replaced with the invitation in this request. Note: The the convertCandidateToBankingCustomer operation implicitly deletes the candidate customer resource that this operation creates.

Body parameter

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "name": "Phil Duciary",
  "alternateName": "Philip K. Duciary",
  "coreCustomerId": "3392c022c74aad2bb8e5",
  "nickname": "Max",
  "enrollmentState": "enrolled",
  "type": "retail",
  "middleName": "K.",
  "contactCard": {
    "phoneNumbers": {
      "primary": "+1919555-1234"
    },
    "emailAddresses": {
      "primary": "phil.duciary@example.com"
    }
  },
  "taxId": "111223333",
  "birthdate": "2003-08-24",
  "employee": "notAnEmployee",
  "electronicDocumentElectionDefault": true,
  "electronicStatementElectionDefault": true,
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  }
}

Parameters

Parameter	Description
`Apiture-Viewer-Country` `in: header`	`countryCode` For operations which support this request header, this header's value is the ISO-3611 alpha-2 2-letter country code of the location of the person using the application which is invoking the API operation. For some service configurations, the operation may return a 403 Forbidden response if the financial institution restricts the activity from the country. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`Apiture-Viewer-Address` `in: header`	`ipAddressAndPort` For operations which support this request header, this header's value is the IP address of the person using the application which is invoking the API operation, and the source port of the request. `pattern: "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}:[0-9]{1,5}$\|^\\[?[A-Fa-f0-9:]+\\]?:[0-9]{1,5}$\|^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$\|^\\[?[A-Fa-f0-9:]+\\]?$"`
`body`	`newCandidateCustomer`

Example responses

201 Response

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "id": "7da296a8efab234ccb54",
  "type": "retail",
  "scope": "person",
  "name": "Phil Duciary",
  "enrollmentState": "pendingEnrollment",
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "9105550150"
    }
  },
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  },
  "invitation": {
    "id": "6b268025bba0d74befce",
    "redirect_url": "https://www.example.com/complete-customer-registration?invitation=6b268025bba0d74befce"
  }
}

Responses

Status	Description
201	Created
	Created.
	Schema: `candidateCustomer`
Header	`Location` `string` `uri-reference`
	The URI of the saved candidate customer profile.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/geoRestrictionViolation/v1.0.0
The API request originated in a restricted country or region. Remediation: The end user must be located in a non-restricted country or region.

Schema: problemResponse

Status Description

409 Conflict

Conflict. A new customer cannot be created, as there is already a matching customer.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/customerAlreadyExists/v1.0.0
A customer with this key identification data (taxId and/or coreCustomerId) already exists. Remediation: Try again with different key data.
https://production.api.apiture.com/errors/createCandidateBankingCustomerOperationNotConfigured/v1.0.0
A customer with this key identification data (taxId) already exists. Remediation: Try again with different key data.
https://production.api.apiture.com/errors/customerIsLocked/v1.0.0
The financial institution has locked new banking activity for the given customer taxId. Remediation: Inform the customer that the financial institution has locked new banking activity.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidCandidateCustomer/v1.0.0
The supplied profile data is invalid. Remediation: Provide valid customer profile data.
https://production.api.apiture.com/errors/usernamePolicyViolation/v1.0.0
The supplied username violates the financial institution's username policies. Remediation: Have the customer provide a username that satisfies the financial institution's username policies.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getCandidateBankingCustomer

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Get a candidate customer's profile

GET https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}

Return a previously saved candidate customer's profile.

Parameters

Parameter	Description
`candidateCustomerId` `in: path`	`resourceId` (required) The profile ID returned when `creating a candidate customer profile`. This is the `id` property in the `candidateCustomer` response for that operation. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "id": "7da296a8efab234ccb54",
  "type": "retail",
  "scope": "person",
  "name": "Phil Duciary",
  "enrollmentState": "pendingEnrollment",
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "9105550150"
    }
  },
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  },
  "invitation": {
    "id": "6b268025bba0d74befce",
    "redirect_url": "https://www.example.com/complete-customer-registration?invitation=6b268025bba0d74befce"
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `candidateCustomer`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

deleteCandidateBankingCustomer

Code samples

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

DELETE https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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/problem+json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Delete the candidate customer and all associated invitations

DELETE https://api.apiture.com/bankingAdmin/candidateCustomers/{candidateCustomerId}

Delete the specified candidate customer and delete any invitations associated with the candidate customer. This operation can be called by a client to revoke a pending user, e.g. when a subuser is invited and a subuser administrator deletes the invitation prior to the user accepting it.

Parameters

Parameter	Description
`candidateCustomerId` `in: path`	`resourceId` (required) The profile ID returned when `creating a candidate customer profile`. This is the `id` property in the `candidateCustomer` response for that operation. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

400 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
  "title": "Bad Request",
  "status": 400,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "Input did not parse as JSON",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

Status	Description
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getInvitedCandidateBankingCustomer

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Get the candidate customer's profile information associated with a specific customer invitation.

GET https://api.apiture.com/bankingAdmin/invitedCandidateCustomers/{candidateCustomerInvitationId}

Return a customer's profile information associated with the invitation.

The candidateCustomer.invitation.id, passed here as the {candidateCustomerInvitationId} path parameter, must be current. If the candidate customer has been deleted or converted, or the corresponding invitation has expired or replaced by a more recent invitation, this operation fails with a 404 Not Found response.

Parameters

Parameter	Description
`candidateCustomerInvitationId` `in: path`	`externalResourceId` (required) The invitation ID returned when `creating a candidate customer profile`. This is the `invitation.id` property in the `candidateCustomer` response for that operation. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "id": "7da296a8efab234ccb54",
  "type": "retail",
  "scope": "person",
  "name": "Phil Duciary",
  "enrollmentState": "pendingEnrollment",
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "9105550150"
    }
  },
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  },
  "invitation": {
    "id": "6b268025bba0d74befce",
    "redirect_url": "https://www.example.com/complete-customer-registration?invitation=6b268025bba0d74befce"
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `candidateCustomer`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

validateBankingCustomerAuthentication

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "username": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCB1c2VybmFtZS48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQ==",
  "password": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCBwYXNzd29yZC48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQo=",
  "encryptedWith": "B74ae2504D8E"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

}, headers = headers)

print r.json()

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

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

Validate user credentials and return matching customer data

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

Validate if a customer exists with the customer credentials in the request body and return the matched customer data if found.

Body parameter

{
  "username": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCB1c2VybmFtZS48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQ==",
  "password": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCBwYXNzd29yZC48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQo=",
  "encryptedWith": "B74ae2504D8E"
}

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the full account number. Such requests are auditable. `default: false`
`body`	`bankingCustomerCredentials` (required) `Unevaluated Properties: false`

Example responses

200 Response

{
  "found": true,
  "customer": {
    "id": "3a6b72311531ffc64d42",
    "coreCustomerId": "0964e98c6edeab9dc098",
    "name": "Max Peck",
    "type": "retail",
    "state": "enabled",
    "scope": "person",
    "taxId": "112223333",
    "emailAddresses": {
      "primary": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "+19105550150"
    },
    "authenticationChallengeFactors": [
      {
        "type": "email",
        "email": {
          "primary": true,
          "secondary": false
        }
      },
      {
        "type": "sms",
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        }
      },
      {
        "type": "voice",
        "voice": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        }
      }
    ]
  }
}

Responses

Status	Description
200	OK
	OK. The request was processed.
	Schema: `bankingCustomerAuthentication`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/dataNotEncrypted/v1.0.0
Properties in the request body were not encrypted correctly. Remediation: Encrypt each property that requires encryption using the public encryption key obtained from the Platform Encryption API, and list the encryption key id in the encryptedWith property.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customers Administration Actions

Administrative Actions on Customers

enableBankingCustomer

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/enabled 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/bankingCustomers/{bankingCustomerId}/enabled',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/enabled',
  method: 'post',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/enabled', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Enable a banking customer

POST https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/enabled

Enable a banking customer. This changes the enrollmentState of the banking customer to enrolled. The response is the updated representation of the banking customer. This operation is idempotent: no changes are made if the banking customer's enrollmentState is already enabled.

Parameters

Parameter	Description
`bankingCustomerId` `in: path`	`resourceId` (required) The unique identifier of this banking customer. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Responses

Status	Description
200	OK
	OK. The operation succeeded. The banking customer resource was updated and its `enrollmentState` changed to `enabled`, or the state was already `enabled`.
	Schema: `bankingCustomer`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

409 Conflict

Conflict. A new customer cannot be enabled because the financial institution has locked the customer.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/customerIsLocked/v1.0.0
The financial institution has locked new banking activity for the given customer taxId. Remediation: Inform the customer that the financial institution has locked new banking activity.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

markBankingCustomerIdentityAsMigrated

Code samples

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

POST https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/identityMigrated HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/identityMigrated',
{
  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/bankingCustomers/{bankingCustomerId}/identityMigrated',
  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/bankingCustomers/{bankingCustomerId}/identityMigrated',
  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/bankingCustomers/{bankingCustomerId}/identityMigrated', params={

}, headers = headers)

print r.json()

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

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

Mark a customer identity as migrated

POST https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/identityMigrated

Mark a customer identity as migrated, indicating that the financial institution has connected the customer identity (in the financial institution-supplied identity provider) with the customer's record in Apiture Digital Banking.

This operation is idempotent: no changes are made if the banking customer's identityState is already migrated.

Body parameter

{}

Parameters

Parameter	Description
`body`	`migratedBankingCustomer` (required)
`bankingCustomerId` `in: path`	`resourceId` (required) The unique identifier of this banking customer. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Responses

Status	Description
200	OK
	OK. The operation succeeded. The banking customer resource was updated and its `identityMigrationState` changed to `migrated`, or the state was already `migrated`.
	Schema: `bankingCustomer`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

409 Conflict

Conflict. The system could not mark the customer as migrated.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/conflict/v1.0.0
The request could not be completed due to a conflict with the current state of the target resource. Remediation: Try another operation that is allowed.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

convertCandidateToBankingCustomer

Code samples

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

POST https://api.apiture.com/bankingAdmin/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "subjectId": "dac94134-248f97f23ec6",
  "username": "peck_plumbing"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered',
{
  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/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered',
  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/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered',
  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/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered', params={

}, headers = headers)

print r.json()

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

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

Complete the invitation by converting the associated candidate customer to a customer.

POST https://api.apiture.com/bankingAdmin/invitedCandidateCustomers/{candidateCustomerInvitationId}/registered

Complete a candidate customer's registration (sign up) flow for the given invitation and convert a candidate customer to a customer.

This operation is called by the financial institution's user management when the customer has completed the financial institution's identity provider sign up process for the invitation that was created with createCandidateBankingCustomer.

Note: Successful completion of this operation removes the candidate customer resource at /candidateCustomers/{candidateCustomerId}/ (alias /invitedCandidateCustomers/{candidateCustomerInvitationId}) as well as the associated candidate customer invitation.

Body parameter

{
  "subjectId": "dac94134-248f97f23ec6",
  "username": "peck_plumbing"
}

Parameters

Parameter	Description
`body`	`candidateCustomerConversion`
`candidateCustomerInvitationId` `in: path`	`externalResourceId` (required) The invitation ID returned when `creating a candidate customer profile`. This is the `invitation.id` property in the `candidateCustomer` response for that operation. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "institutionId": "TIBURON",
  "subjectId": "string",
  "restricted": true,
  "taxId": "112-22-3333",
  "referenceId": "string",
  "identitySource": "digitalBanking",
  "birthdate": "20**-**-**",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": true,
    "openRetailAccounts": true,
    "addExternalAccount": true
  },
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "+19105550150"
    }
  },
  "username": "string",
  "id": "string",
  "type": "commercial",
  "scope": "person",
  "state": "enabled",
  "name": "string",
  "employee": "employee",
  "return_url": "http://example.com"
}

Responses

Status	Description
200	OK
	OK. The candidate invitation was successfully completed and the associated candidate customer was converted to a customer. The current banking customer is returned, including the `return_url` used to create the candidate customer, if any.
	Schema: `convertedCandidateCustomer`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

409 Conflict

Conflict. The system could not process the invitation or could not convert the candidate customer to a customer.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/usernameAlreadyInUse/v1.0.0
A customer with this username already exists. Remediation: Provide a valid username that is not already in use.
https://production.api.apiture.com/errors/subjectIdAlreadyInUse/v1.0.0
A customer with this subjectId already exists. Remediation: Provide a valid subjectId that is not already in use.
https://production.api.apiture.com/errors/customerIsLocked/v1.0.0
The financial institution has locked new banking activity for the given customer taxId. Remediation: Inform the customer that the financial institution has locked new banking activity.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Sessions

listActiveBankingCustomerSessions

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return a list of a customer/member's sessions.

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

Return a list of a customer/member's active sessions. One of ?customerId= or ?sessionId must be provided. If both are provided, the sessionId is used and the customerId is ignored.

Parameters

Parameter	Description
`customerId` `in: query`	`externalResourceId` The customer's subject ID (`sub`) within the Identity Provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`sessionId` `in: query`	`externalResourceId` The logged in user's session ID (`sid`) within the Identity Provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "items": [
    {
      "subjectId": "string",
      "sessionId": "string",
      "preferredUsername": "string",
      "displayName": "string",
      "startedAt": "2021-10-30T19:06:04.250Z",
      "expiresAt": "2021-10-30T19:06:04.250Z",
      "applicationId": "string"
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerSessions`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

terminateOpenIdConnectBankingCustomerSession

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/terminatedOpenIdConnectCustomerSessions/{institutionId} \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json'

POST https://api.apiture.com/bankingAdmin/terminatedOpenIdConnectCustomerSessions/{institutionId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/x-www-form-urlencoded
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "logout_token": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'

};

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

var headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/terminatedOpenIdConnectCustomerSessions/{institutionId}',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded',
  'Accept' => 'application/json'
}

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

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/json'
}

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/terminatedOpenIdConnectCustomerSessions/{institutionId}");
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/x-www-form-urlencoded"},
        "Accept": []string{"application/json"},
        
    }

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

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

Terminate an OpenID Connect session

POST https://api.apiture.com/bankingAdmin/terminatedOpenIdConnectCustomerSessions/{institutionId}

Terminate a session as per OpenID Connect Back-Channel Logout Request. The logout_token in the application/x-www-form-urlencoded request contains a session ID claim which determines which session to terminate.

Notes: * This operation is called from the Identity Provider and thus does not use user or system credentials. The implementation may rate limit this. Requests require a valid logout_token, to prevent spoofing.

The response should contain a Cache-Control: no-store response header to prevent caching of the response. * Errors return an OAuth 2 JSON response object as per OpenID Connect for this logout URI. * This operation is idempotent: if called when there are no customer sessions, the operation returns 204 again. * Implementations may return just a generic 400 response for any invalid request, as that is all that OIDC requires.

Body parameter

logout_token: string

Parameters

Parameter	Description
`institutionId` `in: path`	`institutionId` (required) The unique immutable identifier of a financial institution. `minLength: 2` `maxLength: 8` `pattern: "^[A-Z0-9_]{2,8}$"`
`body`	`sessionTerminationRequest`

Example responses

400 Response

{
  "error": "invalid_request",
  "error_description": "string"
}

Responses

Status	Description
204	No Content
	OK, no content. The sessions were terminated, or no customer sessions were found.

Status	Description
400	Bad Request
	Bad Request.
	Schema: `oauth2Error`

Status	Description
401	Unauthorized
	Unauthorized.
	Schema: `oauth2Error`

Status	Description
403	Forbidden
	Forbidden.
	Schema: `oauth2Error`

Status	Description
404	Not Found
	Not Found. No such institution.
	Schema: `oauth2Error`

Status	Description
422	Unprocessable Entity
	Unprocessable Entity.
	Schema: `oauth2Error`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

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

API problem or error, as per RFC 7807 application/problem+json.

Properties

Name	Description
`API Problem (v1.2.2)`	`object` API problem or error, as per RFC 7807 application/problem+json.
`type`	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `format: uri-reference` `maxLength: 2048`
`title`	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `format: text` `maxLength: 120`
`status`	`integer(int32)` The HTTP status code for this occurrence of the problem. `format: int32` `minimum: 100` `maximum: 599`
`detail`	`string(text)` A human-readable explanation specific to this occurrence of the problem. `format: text` `maxLength: 256`
`instance`	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `format: uri-reference` `maxLength: 2048`
`id`	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`occurredAt`	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`problems`	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128` items: `object`

bankingCustomer

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "referenceId": "97531",
  "subjectId": "dac94134-248f97f23ec6",
  "institutionId": "TIBURON",
  "taxId": "*****3333",
  "restricted": true,
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "type": "commercial",
  "scope": "person",
  "birthdate": "20**-**-*1",
  "state": "enabled",
  "enrollmentState": "enrolled",
  "identitySource": "digitalBanking",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "identityMigrationState": "migrated",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": false,
    "openRetailAccounts": false,
    "addExternalAccount": true
  }
}

Banking Customer (v7.0.0)

Representation of a banking customer resource.

Properties

Name Description

Banking Customer (v7.0.0) object
Representation of a banking customer resource.

enrollmentState

bankingCustomerEnrollmentState

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

username customerUsername(text) (required)
A customer's login username. This property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

subjectId subjectId(text)
The ID of the customer in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

id readOnlyResourceId (required)
The unique identifier for this banking customer (member) resource. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

state

bankingCustomerState (required)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

enum values: enabled, disabled, locked

scope bankingCustomerScope (required)
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

lastLoggedInAt readOnlyTimestamp(date-time)
The date and time when the customer last logged in via any channel, in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
read-only
format: date-time
minLength: 20
maxLength: 30

lastLoginAttemptedAt readOnlyTimestamp(date-time)
The date and time when the customer last attempted to log in, whether successful or failed, in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
read-only
format: date-time
minLength: 20
maxLength: 30

createdAt readOnlyTimestamp(date-time)
The date and time when the customer relationship with the financial institution was created in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
read-only
format: date-time
minLength: 20
maxLength: 30

enrolledAt readOnlyTimestamp(date-time)
The date and time when the customer was enrolled in digital banking in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
read-only
format: date-time
minLength: 20
maxLength: 30

identityMigrationState

bankingCustomerIdentityMigrationState

The state of a banking customer's identity migration.

bankingCustomerIdentityMigrationState strings may have one of the following enumerated values:

Value	Description
`unknown`	Unknown: The migration status of the customer record is unknown.
`migrated`	Migrated: The customer's identity has been migrated.

enum values: unknown, migrated

identitySource

bankingCustomerIdentitySource (required)

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

enum values: digitalBanking, external, pendingExternal

coreCustomerId coreCustomerId
The unique ID of the customer (member) in the banking core. This value is not available on all banking cores or may not yet be set for pending customers.
minLength: 1
maxLength: 48
pattern: "^[ -_:.~$a-zA-Z0-9]{1,48}$"

name string(text) (required)
The customer's full name.
format: text
minLength: 1
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

nickname string(text)
The customer's nickname or greeting name; only present if the customer has assigned their nickname.
format: text
minLength: 1
maxLength: 20

employee

bankingCustomerInstitutionEmployeeState (required)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

institutionId institutionId (required)
The ID of the institution where this customer is enrolled in digital banking.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

restricted boolean (required)
true if this customer is a restricted member of an organization, also known as a subuser. Restricted customers can ony be associated with one organization and cannot open retail accounts.

taxId bankingCustomerTaxId(text)
The customer's US social security number (SSN) or individual taxpayer ID number (ITIN), In responses, this value is masked (all but the last four digits are replaced with one or more asterisks *). Use ?unmasked=true to include the full taxId in responses. Unmasked responses exclude formatting hyphens (NNNNNNNNN format). In requests, up to two hyphens are allowed (NNN-NN-NNNN format).
format: text
minLength: 9
maxLength: 11

referenceId

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

__Note___: This property is deprecated and will be removed when the platform stops supporting numeric IDs to reference customers and adopts more robust/secure (UUID-like) id strings only.
deprecated: true
minLength: 2
maxLength: 12
pattern: "^[0-9]{2,12}$"

birthdate string(text)
The customer's date of birth. This property may be masked (some digits replaced with *) unless unmasked data is requested.
format: text
minLength: 10
maxLength: 10
pattern: "^(19|20|\\*\\*)[0-9*]{2}-[0-9*]{2}-[0-9*]{2}$"

electronicStatementElectionDefault boolean (required)
If true then the customer has consented to receive statements electronically (via email or download) instead of postal mail for any new accounts they are associated with.

electronicDocumentElectionDefault boolean (required)
If true then the customer has consented to receive other documents (not statements) electronically (via email or download) instead of postal mail for any new accounts they are associated with.

allows bankingCustomerPermissions (required)
Flags which indicate the permissions the banking customer has within digital banking. This is separate from specific permissions/entitlements the customer may have over organizations, banking accounts, other customers, or applications.

contactCard customerContactCard (required)
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.

bankingCustomerAddressesPatch

{
  "primary": {
    "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 Customer Addresses Patch (v2.0.0)

Updates of postal addresses for a banking customer.

Properties

Name	Description
`New Banking Customer Addresses Patch (v2.0.0)`	`object` Updates of postal addresses for a banking customer.
`primary`	`requestAddress` The customer's primary address. For individuals, this is their home address. For businesses, this is the company's business address.
`mailing`	`requestAddress` The customer's mailing address. If present, financial institution sends statements and other documents to this address instead of the `primary` address.

bankingCustomerAuthentication

{
  "found": true,
  "customer": {
    "id": "3a6b72311531ffc64d42",
    "coreCustomerId": "0964e98c6edeab9dc098",
    "name": "Max Peck",
    "type": "retail",
    "state": "enabled",
    "scope": "person",
    "taxId": "112223333",
    "emailAddresses": {
      "primary": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "+19105550150"
    },
    "authenticationChallengeFactors": [
      {
        "type": "email",
        "email": {
          "primary": true,
          "secondary": false
        }
      },
      {
        "type": "sms",
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        }
      },
      {
        "type": "voice",
        "voice": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        }
      }
    ]
  }
}

Banking Customer Authentication (v3.0.0)

The result of validating a banking customer's credentials.

Properties

Name	Description
`Banking Customer Authentication (v3.0.0)`	`object` The result of validating a banking customer's credentials. `Unevaluated Properties: false`
`found`	`boolean` (required) `true` if a customer was found with the supplied credentials, `false` otherwise.
`customer`	`bankingCustomerRecord` The details of the existing customer. This value is only present if `found` is `true`. `Unevaluated Properties: false`

bankingCustomerAuthenticationChallengeFactor

{
  "type": "email",
  "email": {
    "primary": true,
    "secondary": false
  }
}

Banking Customer Authentication Challenge Factor (v1.0.0)

A banking customer's challenge factor. This describes how the customer is challenged to verify their identity for multi-factor authentication, and the channels by which the customer can complete such challenges.

Properties

Name	Description
`Banking Customer Authentication Challenge Factor (v1.0.0)`	`object` A banking customer's challenge factor. This describes how the customer is challenged to verify their identity for multi-factor authentication, and the channels by which the customer can complete such challenges. `Unevaluated Properties: false`
`type`	`challengeFactorType` Indicates the type of an identity challenge enum values: `sms`, `email`, `voice`, `securityQuestions`, `authenticatorToken`
`email`	`customerEmailChallengeChannels` Indicates which of the customer's email addresses may be used for an `email` identity challenge or multi-factor authentication.
`sms`	`customerPhoneChallengeChannels` Indicates which of the customer's email addresses may be used for a `sms` (text message) identity challenge or multi-factor authentication.
`voice`	`customerPhoneChallengeChannels` Indicates which of the customer's email addresses may be used for a `voice` (automated voice call) identity challenge or multi-factor authentication.

bankingCustomerAuthenticationChallengeFactors

[
  {
    "type": "email",
    "email": {
      "primary": true,
      "secondary": false
    }
  },
  {
    "type": "sms",
    "sms": {
      "primary": false,
      "secondary": false,
      "mobile": true,
      "alternate": true
    }
  },
  {
    "type": "voice",
    "voice": {
      "primary": false,
      "secondary": false,
      "mobile": true,
      "alternate": true
    }
  }
]

Banking Customer Authentication Challenge Factors (v1.0.0)

Authentication challenge factors for a banking customer. The order of items in this array represents the order in which the user must complete the secondary authentication challenges.

bankingCustomerAuthenticationChallengeFactors is an array schema.

Array Elements

type: array: [bankingCustomerAuthenticationChallengeFactor]

minItems: 0
maxItems: 8

bankingCustomerBusinessRole

"agent"

Banking Customer Business Role (v1.0.0)

For business customers, this indicates the customer's banking role.

bankingCustomerBusinessRole strings may have one of the following enumerated values:

Value	Description
`agent`	Agent: Acts as an agent on behalf of a business or organization.
`restricted`	Restricted: A user with restricted access to the business accounts (also known as a "subuser").
`other`	Other: The customer has some other busines banking role.
`unknown`	Unknown: The customer has busines banking role that is unknown.

type: string

enum values: agent, restricted, other, unknown

bankingCustomerContactCardPatch

{
  "addresses": {
    "primary": {
      "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": "Max.Peck@example.com",
    "secondary": "MaxwellPeck@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "9105550150"
  }
}

Banking Customer Contact Card Patch (v3.0.0)

An update to a banking customer's contact information.

Properties

Name	Description
`Banking Customer Contact Card Patch (v3.0.0)`	`object` An update to a banking customer's contact information. `Unevaluated Properties: false`
`addresses`	`bankingCustomerAddressesPatch` The customer's postal addresses.
`emailAddresses`	`bankingCustomerEmailAddressesPatch` The customer's email addresses. `Unevaluated Properties: false`
`phoneNumbers`	`bankingCustomerPhoneNumbersPatch` The customer's phone numbers. `Unevaluated Properties: false`

bankingCustomerCredentials

{
  "username": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCB1c2VybmFtZS48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQ==",
  "password": "MDEyMzQ1NTQzMjE+PlRoaXMgc2FtcGxlIHZhbHVlIHNob3VsZCBiZSB0aGUgQmFzZTY0IGVuY29k ZWQgdmFsdWUgb2YgdGhlIGVuY3J5cHRlZCBwYXNzd29yZC48PDAxMjM0NTU0MzIxCjAxMjM0NTU0 MzIxPj5UaGlzIHNhbXBsZWQgZGF0YSBpcyBub3QgYWN0dWFsbHkgZW5jcnlwdGVkLCBidXQgY29k ZWQgdG8gbG9vayBsaWtlIGJpbmFyeTw8MDEyMzQ1NTQzMjEKMDEyMzQ1NTQzMjE+PmRhdGEuPDww MTIzNDU1NDMyMQo=",
  "encryptedWith": "B74ae2504D8E"
}

Banking Customer Credentials (v2.0.0)

Note: The client must use the Platform Encryption API to get a public encryption key for encrypting the username and password then Base64 encode the encrypted data when building this request body. This request body includes the required encryptedWith property which lists the id of the encryption key that the client used to encrypt the properties.

Properties

Name	Description
`Banking Customer Credentials (v2.0.0)`	`object` Login credentials for a banking customer. Note: The client must use the Platform Encryption API to get a public encryption key for encrypting the `username` and `password` then Base64 encode the encrypted data when building this request body. This request body includes the required `encryptedWith` property which lists the `id` of the encryption key that the client used to encrypt the properties. `Unevaluated Properties: false`
`username`	`encryptedString` (required) The username (A.K.A. access ID) of the customer record being validated. The value of the `username` property must be encrypted with a recent public encryption key (obtained from the `getPublicEncryptionKey` operation in the Platform Encryption API), then Base64 encoded. `minLength: 120` `maxLength: 8096`
`password`	`encryptedString` (required) The password (A.K.A. passcode) of the customer record being validated. The value of the `password` property must be encrypted with a recent public encryption key (obtained from the `getPublicEncryptionKey` operation in the Platform Encryption API), then Base64 encoded. `minLength: 120` `maxLength: 8096`
`encryptedWith`	`encryptedWith` (required) The `id` of the public encryption key instance the client used to encrypt the data. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

bankingCustomerEmailAddressesPatch

{
  "primary": "Max.Peck@example.com",
  "secondary": "MaxwellPeck@me.example.com"
}

New Banking Customer Email Addresses Patch (v1.0.0)

Updates of email addresses for a banking customer.

Properties

Name	Description
`New Banking Customer Email Addresses Patch (v1.0.0)`	`object` Updates of email addresses for a banking customer. `Unevaluated Properties: false`
`primary`	`customerEmailAddress(email)` The primary email address of the customer. `format: email` `maxLength: 255`
`secondary`	`customerEmailAddress(email)` The secondary email address of the customer. This value is omitted if there is not a secondary email address. `format: email` `maxLength: 255`

bankingCustomerEnrollmentState

"pendingApplicant"

Banking Customer Enrollment State (v1.0.0)

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

type: string

enum values: pendingApplicant, pendingEnrollment, enrolled

bankingCustomerIdentityMigrationState

"unknown"

Banking Customer Identity Migration State (v1.0.0)

The state of a banking customer's identity migration.

bankingCustomerIdentityMigrationState strings may have one of the following enumerated values:

Value	Description
`unknown`	Unknown: The migration status of the customer record is unknown.
`migrated`	Migrated: The customer's identity has been migrated.

type: string

enum values: unknown, migrated

bankingCustomerIdentitySource

"digitalBanking"

Banking Customer Identity Source (v1.0.0)

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

type: string

enum values: digitalBanking, external, pendingExternal

bankingCustomerInstitutionEmployeeState

"employee"

Banking Customer FI Employee State (v1.0.0)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

type: string

enum values: employee, notAnEmployee, unknown

bankingCustomerItem

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "name": "Peck Plumbing",
  "type": "commercial",
  "enrollmentState": "enrolled",
  "identityMigrationState": "unknown",
  "state": "enabled",
  "commercial": {
    "contactName": "Max Peck"
  },
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "identityChallengeFactors": {
    "email": {
      "primary": true,
      "secondary": false
    },
    "sms": {
      "primary": false,
      "secondary": false,
      "mobile": true,
      "alternate": false
    },
    "voice": {
      "primary": false,
      "secondary": true,
      "mobile": true,
      "alternate": true
    }
  },
  "employee": "unknown",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z"
}

Banking Customer Item (v5.0.1)

Summary representation of a banking customer (member) resource in banking customers collections. To fetch the full representation of this banking customer, use the getBankingCustomer operation, passing this item's id field as the bankingCustomerId path parameter.

Personally Identifiable Information (PII) in the customer record are masked by default. Use ?unmasked=true in the request to unmask the data. The example shows unmasked data.

Properties

Name Description

Banking Customer Item (v5.0.1)

object
Summary representation of a banking customer (member) resource in banking customers collections. To fetch the full representation of this banking customer, use the getBankingCustomer operation, passing this item's id field as the bankingCustomerId path parameter.

Personally Identifiable Information (PII) in the customer record are masked by default. Use ?unmasked=true in the request to unmask the data. The example shows unmasked data.

enrollmentState

bankingCustomerEnrollmentState

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

subjectId subjectId(text)
The customer's subject ID in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

state

bankingCustomerState (required)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

enum values: enabled, disabled, locked

scope bankingCustomerScope
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

identityMigrationState

bankingCustomerIdentityMigrationState

The state of a banking customer's identity migration.

bankingCustomerIdentityMigrationState strings may have one of the following enumerated values:

Value	Description
`unknown`	Unknown: The migration status of the customer record is unknown.
`migrated`	Migrated: The customer's identity has been migrated.

enum values: unknown, migrated

identitySource

bankingCustomerIdentitySource

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

enum values: digitalBanking, external, pendingExternal

name string(text) (required)
The customer's full name.
format: text
minLength: 1
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

nickname string(text)
The customer's nickname or greeting name; only present if the customer has assigned their nickname.
format: text
minLength: 1
maxLength: 20

employee

bankingCustomerInstitutionEmployeeState (required)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

contactCard customerContactCard (required)
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.

retail retailBankingCustomer
Customer properties, present only if the customer type is retail. Either of the retail or commercial properties are present, but not both.

commercial commercialBankingCustomer
Customer properties, present only if the customer type is commercial. Either of the retail or commercial properties are present, but not both.

identityChallengeFactors customerIdentityChallengeFactors
Indicates which which channels (specific email addresses or specific phone numbers) are enabled for the email, sms or voice factors when performing multi-factor authentication and other identity challenges.

bankingCustomerList

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "coreCustomerId": "12299292",
      "username": "peck_plumbing",
      "name": "Peck Plumbing",
      "type": "commercial",
      "state": "enabled",
      "commercial": {
        "contactName": "Max Peck"
      },
      "contactCard": {
        "addresses": {
          "primary": {
            "address1": "1805 Tiburon Dr.",
            "address2": "Building 14, Suite 1500",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          },
          "mailing": {
            "address1": "P.O. Box 0000000",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          }
        },
        "emailAddresses": {
          "primary": "max@example.com",
          "secondary": "plank_plumbing@example.com"
        },
        "phoneNumbers": {
          "primary": "+19105555512",
          "mobile": "9105555513",
          "alternate": "+19105555514",
          "fax": "+19105555514"
        }
      },
      "identityChallengeFactors": {
        "email": {
          "primary": true,
          "secondary": false
        },
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        },
        "voice": {
          "primary": false,
          "secondary": true,
          "mobile": true,
          "alternate": true
        }
      },
      "employee": "notAnEmployee",
      "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
      "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
      "createdAt": "2020-05-04T12:37:08.375Z",
      "enrolledAt": "2020-05-04T12:37:08.375Z"
    }
  ]
}

Banking Customer List (v5.0.1)

A list of banking customers.

Personally Identifiable Information (PII) in the customer record are masked by default. Use ?unmasked=true in the request to unmask the data. The example shows masked data, although the examples do not imply or dictate any specific masking rules. See the bankingCustomerItem schema for an example with unmasked data.

Properties

Name Description

Banking Customer List (v5.0.1)

object
A list of banking customers.

items array: [bankingCustomerItem] (required)
An array of banking customers.
minItems: 1
maxItems: 32
items: object

bankingCustomerPatch

{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "name": "Max Peck",
  "alternateName": "Maxwell Peck",
  "nickname": "Max",
  "birthdate": "2002-10-31",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "subjectId": "dac94134-248f97f23ec6",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true
}

Banking Customer Patch (v6.0.0)

Request body to update a banking customer 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.

Properties

Name Description

Banking Customer Patch (v6.0.0) object
Request body to update a banking customer 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.
Unevaluated Properties: false

name string(text)
The customer's full name.
format: text
minLength: 1
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

nickname string(text)
The customer's nickname or greeting name; only present if the customer has assigned their nickname.
format: text
minLength: 1
maxLength: 20

type customerType
Indicates the type of digital banking customer/member.
enum values: commercial, retail

employee

bankingCustomerInstitutionEmployeeState

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

username

customerUsername(text)
The customer's login username.

The calling client application must have the bankingAdmin/writeUsername client credentials authorization scope to update the username.
format: text
minLength: 5
maxLength: 128

subjectId subjectId(text)
The customer's subject ID in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

contactCard bankingCustomerContactCardPatch
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.
Unevaluated Properties: false

electronicStatementElectionDefault boolean
If true then the customer has consented to receive statements electronically (via email or download) instead of postal mail for any new accounts they are associated with.

electronicDocumentElectionDefault boolean
If true then the customer has consented to receive other documents (not statements) electronically (via email or download) instead of postal mail for any new accounts they are associated with.

bankingCustomerPermissions

{
  "createOrganization": true,
  "openRetailAccounts": true,
  "addExternalAccount": true
}

Banking Customer Permissions (v2.0.0)

The set of banking operations and actions that are allowed for the customer, excluding permissions related to specific commercial businesses or to specific accounts.

Properties

Name	Description
`Banking Customer Permissions (v2.0.0)`	`object` The set of banking operations and actions that are allowed for the customer, excluding permissions related to specific commercial businesses or to specific accounts.
`createOrganization`	`boolean` (required) The customer is allowed to create new organizations for commercial banking.
`openRetailAccounts`	`boolean` (required) The customer is allowed to open new retail banking accounts.
`addExternalAccount`	`boolean` (required) If `true`, the customer is allowed to add additional external banking accounts.

bankingCustomerPhoneNumbersPatch

{
  "primary": "+19105550155",
  "mobile": "9105550150"
}

New Banking Customer Phone Numbers Patch (v2.0.0)

Updates of phone numbers for a banking customer, using JSON Merge Patch semantics.

Properties

Name	Description
`New Banking Customer Phone Numbers Patch (v2.0.0)`	`object` Updates of phone numbers for a banking customer, using JSON Merge Patch semantics. `Unevaluated Properties: false`
`primary`	`extendedPhoneNumber(extended-phone-number)` The primary phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`secondary`	`extendedPhoneNumber(extended-phone-number)` The new secondary phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`mobile`	`string` The new mobile phone number of the customer. This must be a 10-digit US mobile number. This number may be used for SMS (text message) communication to the customer if the user has opted in for SMS communication. `minLength: 10` `maxLength: 10` `pattern: "^\\d{10}$"`
`alternate`	`extendedPhoneNumber(extended-phone-number)` The new alternate phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`fax`	`extendedPhoneNumber(extended-phone-number)` The new fax number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`

bankingCustomerRecord

{
  "id": "3a6b72311531ffc64d42",
  "coreCustomerId": "0964e98c6edeab9dc098",
  "name": "Max Peck",
  "type": "retail",
  "state": "enabled",
  "scope": "person",
  "taxId": "112223333",
  "emailAddresses": {
    "primary": "Max.Pike@example.com",
    "secondary": "MaxwellPike@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "+19105550150"
  },
  "authenticationChallengeFactors": [
    {
      "type": "email",
      "email": {
        "primary": true,
        "secondary": false
      }
    },
    {
      "type": "sms",
      "sms": {
        "primary": false,
        "secondary": false,
        "mobile": true,
        "alternate": false
      }
    },
    {
      "type": "voice",
      "voice": {
        "primary": false,
        "secondary": false,
        "mobile": true,
        "alternate": false
      }
    }
  ]
}

Banking Customer Record (v3.0.0)

The result of validating a banking customer's credentials.

Properties

Name Description

Banking Customer Record (v3.0.0) object
The result of validating a banking customer's credentials.
Unevaluated Properties: false

id readOnlyResourceId (required)
The resource ID of the banking customer.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

coreCustomerId coreCustomerId
The unique ID of the customer (member) in the banking core. This value is not available on all banking cores.
minLength: 1
maxLength: 48
pattern: "^[ -_:.~$a-zA-Z0-9]{1,48}$"

name string(text) (required)
The full name of the customer.
format: text
minLength: 1
maxLength: 50

emailAddresses customerEmailAddresses (required)
The customer's email addresses.

phoneNumbers customerPhoneNumbers (required)
The customer's phone numbers.

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

state

bankingCustomerState (required)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

enum values: enabled, disabled, locked

scope bankingCustomerScope
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

businessRole bankingCustomerBusinessRole
For business customers (those whose type is commercial), this indicates the customer's banking role relative to the business or organization.
enum values: agent, restricted, other, unknown

authenticationChallengeFactors array: [bankingCustomerAuthenticationChallengeFactor] (required)
Authentication challenge factors for a banking customer. The order of items in this array represents the order in which the user must complete the secondary authentication challenges.
minItems: 0
maxItems: 8
items: object
» Unevaluated Properties: false

taxId bankingCustomerTaxId(text) (required)
The customer's US social security number (SSN) or individual taxpayer ID number (ITIN), In responses, this value is masked (all but the last four digits are replaced with one or more asterisks *). Use ?unmasked=true to include the full taxId in responses. Unmasked responses exclude formatting hyphens (NNNNNNNNN format). In requests, up to two hyphens are allowed (NNN-NN-NNNN format).
format: text
minLength: 9
maxLength: 11

bankingCustomerScope

"person"

Banking Customer Scope (v1.0.0)

Indicates the scope of a banking customer's relationship with digital banking.

type: string

enum values: person, unknown

bankingCustomerSearchCriteria

{
  "taxId": "112223333"
}

Banking Customer Search Criteria (v2.1.1)

Search criteria for looking up banking customers. The request must contain at least one parameter. If multiple parameters are passed, the response is only those customers that match all of the parameters.

Properties

Name	Description
`Banking Customer Search Criteria (v2.1.1)`	`object` Search criteria for looking up banking customers. The request must contain at least one parameter. If multiple parameters are passed, the response is only those customers that match all of the parameters.
`taxId`	`bankingCustomerTaxId(text)` Find customers whose `taxId` matches this value. `format: text` `minLength: 9` `maxLength: 11`
`coreCustomerId`	`coreCustomerId` Find customers whose `coreCustomerId` matches this value. `minLength: 1` `maxLength: 48` `pattern: "^[ -_:.~$a-zA-Z0-9]{1,48}$"`
`email`	`string(email)` Find customers whose primary email address matches this value. `format: email` `minLength: 8` `maxLength: 255`
`username`	`customerUsername(text)` Find customers whose username matches this value. This is a case-sensitive comparison by default. Use the `?ignoreUsernameCase=true` query parameter to change the behavior. `format: text` `minLength: 5` `maxLength: 128`

bankingCustomerState

"enabled"

Banking Customer State (v1.1.0)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

type: string

enum values: enabled, disabled, locked

bankingCustomerTaxId

"112-22-3333"

Banking Customer Tax Id (v1.0.0)

The customer's US social security number (SSN) or individual taxpayer ID number (ITIN), In responses, this value is masked (all but the last four digits are replaced with one or more asterisks *). Use ?unmasked=true to include the full taxId in responses. Unmasked responses exclude formatting hyphens (NNNNNNNNN format). In requests, up to two hyphens are allowed (NNN-NN-NNNN format).

type: string(text)

format: text
minLength: 9
maxLength: 11

candidateCustomer

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "id": "7da296a8efab234ccb54",
  "type": "retail",
  "scope": "person",
  "name": "Phil Duciary",
  "enrollmentState": "pendingEnrollment",
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "9105550150"
    }
  },
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  },
  "invitation": {
    "id": "6b268025bba0d74befce",
    "redirect_url": "https://www.example.com/complete-customer-registration?invitation=6b268025bba0d74befce"
  }
}

Candidate Customer (v6.0.0)

A Candidate Customer is banking customer profile data which is saved for comparison to existing banking customers or to create a new ADB banking customer that is connected to the financial institution's identity provider.

Properties

Name Description

Candidate Customer (v6.0.0) object
A Candidate Customer is banking customer profile data which is saved for comparison to existing banking customers or to create a new ADB banking customer that is connected to the financial institution's identity provider.

name string(text) (required)
The effective name of the candidate customer.
read-only
format: text
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

type customerType
Indicates the type of digital banking customer/member.
enum values: commercial, retail

enrollmentState

bankingCustomerEnrollmentState

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

firstName string(text)
The customer or member's first name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

middleName string(text)
The customer or member's middle name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

lastName string(text)
The customer or member's last (or family) name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

contactCard newCandidateCustomerContactCard
The contact information for the customer.

emailVerified boolean (required)
The customer or member's primary email address has been verified.

phoneNumberVerified boolean
The customer or member's phone number has been verified.

phoneNumberChannel phoneNumberChannel
Indicates the mobile phone communication method (channel) used by the identity provider.
default: "sms"
enum values: sms, voice

connectedIdentifiers array: [connectedIdentifier]
A list of systems where the customer or member has a registered identity.
maxItems: 80
items: object

identityVerified boolean
true if an only if the caller has verified the customer or member's identity on a trusted core or other system.

candidateType

candidateCustomerType

A candidate customer banking customer type.

candidateCustomerType strings may have one of the following enumerated values:

Value	Description
`customer`	Customer: Existing customer or member of the financial institution.
`applicant`	Applicant: Applicant, prospect or other non-customer
`employee`	Employee: An employee or agent of the financial institution

enum values: customer, applicant, employee

timeZoneId timeZoneId(text)
The customer's preferred time zone.
format: text
maxLength: 36

id candidateCustomerId (required)
The candidate customer resource's unique ID. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

referenceId

referenceId
A short, numeric ID value, assigned by the service, that allows administrative application users to reference and look up customers.

username

customerUsername(text)
A customer's login username.

In responses, this property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

invitation invitationReference (required)
The invitation reference for the candidate customer.

scope bankingCustomerScope
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

allows candidateCustomerAllows (required)
Indicates allowed actions for this candidate customer.

candidateCustomerAllows

{
  "createNewLoginCredentials": true,
  "connectToExistingCustomerIdentity": false
}

Candidate Customer Allows (v1.0.0)

Indicates allowed operations for a candidate customer.

Properties

Name	Description
`Candidate Customer Allows (v1.0.0)`	`object` Indicates allowed operations for a candidate customer.
`createNewLoginCredentials`	`boolean` (required) If `true`, the user may register with the financial institution with new login credentials.
`connectToExistingCustomerIdentity`	`boolean` (required) if `true`, the system may connect the candidate customer with an existing banking customer identity.

candidateCustomerConversion

{
  "subjectId": "dac94134-248f97f23ec6",
  "username": "peck_plumbing"
}

Candidate Customer Conversion (v3.0.1)

Request to convert a candidate customer to a customer.

Properties

Name	Description
`Candidate Customer Conversion (v3.0.1)`	`object` Request to convert a candidate customer to a customer.
`subjectId`	`subjectId(text)` (required) The customer's subject ID in the financial institution's identity provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`username`	`customerUsername(text)` (required) The customer's initial login username. `format: text` `minLength: 5` `maxLength: 128`

candidateCustomerId

"string"

Candidate Customer ID (v2.0.0)

Candidate Customer ID.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

candidateCustomerType

"customer"

Candidate Customer Type (v1.0.0)

A candidate customer banking customer type.

candidateCustomerType strings may have one of the following enumerated values:

Value	Description
`customer`	Customer: Existing customer or member of the financial institution.
`applicant`	Applicant: Applicant, prospect or other non-customer
`employee`	Employee: An employee or agent of the financial institution

type: string

enum values: customer, applicant, employee

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: One-time passcode sent to the primary mobile phone number
`email`	Email: One-time passcode sent to the primary email address
`voice`	Voice: One-time passcode communicated via automated voice phone call
`authenticatorToken`	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
`securityQuestions`	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

commercialBankingCustomer

{
  "contactName": "string"
}

Commercial Banking Customer (v1.0.2)

Properties of commercial banking customers.

Properties

Name	Description
`Commercial Banking Customer (v1.0.2)`	`object` Properties of commercial banking customers.
`contactName`	`string(text)` The optional name of the primary contact at the business. `format: text` `minLength: 1` `maxLength: 50`

connectedIdentifier

{
  "systemName": "string",
  "identifier": "string"
}

Connected System Identifier (v1.0.0)

The external system and the customer/member's identifier within that system.

Properties

Name	Description
`Connected System Identifier (v1.0.0)`	`object` The external system and the customer/member's identifier within that system.
`systemName`	`string(text)` (required) The name of the external system where the customer/member has an identity. `format: text` `maxLength: 32`
`identifier`	`string(text)` (required) The customer/member's ID within the external system. `format: text` `maxLength: 40`

convertedCandidateCustomer

{
  "institutionId": "TIBURON",
  "subjectId": "string",
  "restricted": true,
  "taxId": "112-22-3333",
  "referenceId": "string",
  "identitySource": "digitalBanking",
  "birthdate": "20**-**-**",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": true,
    "openRetailAccounts": true,
    "addExternalAccount": true
  },
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "+19105550150"
    }
  },
  "username": "string",
  "id": "string",
  "type": "commercial",
  "scope": "person",
  "state": "enabled",
  "name": "string",
  "employee": "employee",
  "return_url": "http://example.com"
}

Converted Candidate Customer (v3.2.0)

A banking customer converted from a candidate customer.

Properties

Name Description

Converted Candidate Customer (v3.2.0) object
A banking customer converted from a candidate customer.

institutionId institutionId (required)
The ID of the institution where this customer is enrolled in digital banking.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

subjectId subjectId(text)
The ID of the customer in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

referenceId

referenceId (required)
A short, numeric ID value, assigned by the service, that allows administrative application users to reference and look up customers.

identitySource

bankingCustomerIdentitySource (required)

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

enum values: digitalBanking, external, pendingExternal

contactCard customerContactCard (required)
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.

username

customerUsername(text) (required)
A customer's login username.

In responses, this property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

id candidateCustomerId (required)
The candidate customer resource's unique ID. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

scope bankingCustomerScope (required)
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

state

bankingCustomerState (required)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

enum values: enabled, disabled, locked

name string(text) (required)
The effective name of the candidate customer.
read-only
format: text
maxLength: 50

employee

bankingCustomerInstitutionEmployeeState (required)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

return_url string(uri)
The URL of the page or application state in the requesting application where the customer is returned to after completing the enrollment.
format: uri
minLength: 20
maxLength: 4000

convertedCustomerFields

{
  "institutionId": "TIBURON",
  "subjectId": "string",
  "restricted": true,
  "taxId": "112-22-3333",
  "referenceId": "string",
  "identitySource": "digitalBanking",
  "birthdate": "20**-**-**",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "allows": {
    "createOrganization": true,
    "openRetailAccounts": true,
    "addExternalAccount": true
  },
  "contactCard": {
    "addresses": {
      "primary": {
        "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": "Max.Pike@example.com",
      "secondary": "MaxwellPike@me.example.com"
    },
    "phoneNumbers": {
      "primary": "+19105550155",
      "mobile": "+19105550150"
    }
  },
  "username": "string"
}

Converted Customer Fields (v3.1.0)

Fields of a converted Customer, use to compose other schemas.

Properties

Name Description

Converted Customer Fields (v3.1.0) object
Fields of a converted Customer, use to compose other schemas.

institutionId institutionId
The ID of the institution where this customer is enrolled in digital banking.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

subjectId subjectId(text)
The ID of the customer in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

restricted boolean
true if this customer is a restricted member of an organization, also known as a subuser. Restricted customers can ony be associated with one organization and cannot open retail accounts.

referenceId

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

identitySource

bankingCustomerIdentitySource

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

enum values: digitalBanking, external, pendingExternal

allows bankingCustomerPermissions
Flags which indicate the permissions the banking customer has within digital banking. This is separate from specific permissions/entitlements the customer may have over organizations, banking accounts, other customers, or applications.

contactCard customerContactCard
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.

username

customerUsername(text)
A customer's login username.

In responses, this property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

coreCustomerId

"string"

Core Customer Id (v2.0.0)

The unique ID of the customer/member in the banking core.

type: string

minLength: 1
maxLength: 48
pattern: "^[ -_:.~$a-zA-Z0-9]{1,48}$"

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

customerAddresses

{
  "primary": {
    "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"
  }
}

Customer Addresses (v1.0.1)

A customer's postal addresses.

Properties

Name	Description
`Customer Addresses (v1.0.1)`	`object` A customer's postal addresses.
`primary`	`responseAddress` The customer's primary address. For individuals, this is their home address. For businesses, this is the company's business address.
`mailing`	`responseAddress` The customer's mailing address. If present, financial institution sends statements and other documents to this address instead of the `primary` address.

customerContactCard

{
  "addresses": {
    "primary": {
      "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": "Max.Pike@example.com",
    "secondary": "MaxwellPike@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "+19105550150"
  }
}

Customer Contact Card (v3.0.1)

A customer's contact information.

Properties

Name	Description
`Customer Contact Card (v3.0.1)`	`object` A customer's contact information.
`addresses`	`customerAddresses` (required) The customer's postal addresses.
`emailAddresses`	`customerEmailAddresses` (required) The customer's email addresses.
`phoneNumbers`	`customerPhoneNumbers` (required) The customer's phone numbers.

customerEmailAddress

"Max.Pike@example.com"

Customer Email Address (v1.0.0)

A customer's single email address.

type: string(email)

format: email
maxLength: 255

customerEmailAddresses

{
  "primary": "Max.Pike@example.com",
  "secondary": "MaxwellPike@me.example.com"
}

Customer Email Addresses (v1.1.0)

A customer's email addresses.

Properties

Name	Description
`Customer Email Addresses (v1.1.0)`	`object` A customer's email addresses.
`primary`	`customerEmailAddress(email)` The primary email address of the customer. `format: email` `maxLength: 255`
`secondary`	`customerEmailAddress(email)` The secondary email address of the customer. This object is omitted if there is not a secondary email address. `format: email` `maxLength: 255`

customerEmailChallengeChannels

{
  "primary": true,
  "secondary": false
}

Customer Email Address Challenge Channels (v1.0.0)

Indicates which of the customer's email addresses may be used for email multi-factor authentication or other identity challenges. Each address is a separate channel for the email challenge factor.

Properties

Name	Description
`Customer Email Address Challenge Channels (v1.0.0)`	`object` Indicates which of the customer's email addresses may be used for `email` multi-factor authentication or other identity challenges. Each address is a separate channel for the `email` challenge factor.
`primary`	`boolean` (required) If `true`, the `primary` email address may be used as an identity challenge channel.
`secondary`	`boolean` (required) If `true`, the secondary email address may be used as an identity challenge channel.

customerIdentityChallengeFactors

{
  "email": {
    "primary": true,
    "secondary": false
  },
  "sms": {
    "primary": false,
    "secondary": false,
    "mobile": true,
    "alternate": false
  },
  "voice": {
    "primary": false,
    "secondary": true,
    "mobile": true,
    "alternate": true
  }
}

Customer Identity Challenge Factors (v1.0.1)

Indicates which which channels (specific email addresses or specific phone numbers) are enabled for the email, sms or voice factors when performing multi-factor authentication and other identity challenges.

Properties

Name	Description
`Customer Identity Challenge Factors (v1.0.1)`	`object` Indicates which which channels (specific email addresses or specific phone numbers) are enabled for the `email`, `sms` or `voice` factors when performing multi-factor authentication and other identity challenges.
`email`	`customerEmailChallengeChannels` (required) Indicates which of the customer's email addresses may be used for an `email` identity challenge or multi-factor authentication.
`sms`	`customerPhoneChallengeChannels` (required) Indicates which of the customer's email addresses may be used for a `sms` (text message) identity challenge or multi-factor authentication.
`voice`	`customerPhoneChallengeChannels` (required) Indicates which of the customer's email addresses may be used for a `voice` (automated voice call) identity challenge or multi-factor authentication.

customerPhoneChallengeChannels

{
  "primary": false,
  "secondary": false,
  "mobile": true,
  "alternate": true
}

Customer Phone Challenge Channels (v1.0.1)

Indicates which of the customer's phone numbers may be used for phone-based multi-factor authentication or other identity challenges. Each phone number is a separate channel for the sms and voice challenge factors.

Properties

Name	Description
`Customer Phone Challenge Channels (v1.0.1)`	`object` Indicates which of the customer's phone numbers may be used for phone-based multi-factor authentication or other identity challenges. Each phone number is a separate channel for the `sms` and `voice` challenge factors.
`primary`	`boolean` (required) If `true`, the customer's `primary` phone number may be used as an identity challenge channel.
`secondary`	`boolean` (required) If `true`, the customer's `secondary` phone number may be used as an identity challenge channel.
`mobile`	`boolean` (required) If `true`, the customer's `mobile` phone number may be used as an identity challenge channel.
`alternate`	`boolean` (required) If `true`, the customer's `alternate` phone number may be used as an identity challenge channel.

customerPhoneNumbers

{
  "primary": "+19105550155",
  "mobile": "+19105550150"
}

Customer Phone Numbers (v3.0.0)

A customer's phone numbers.

Properties

Name	Description
`Customer Phone Numbers (v3.0.0)`	`object` A customer's phone numbers.
`primary`	`extendedPhoneNumber(extended-phone-number)` The primary phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`secondary`	`extendedPhoneNumber(extended-phone-number)` The secondary phone number of the customer. This object is omitted if there is not a secondary phone number. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`mobile`	`simplePhoneNumber(phone-number)` The mobile phone number of the customer. This object is omitted if there is not a mobile phone number. `format: phone-number` `minLength: 5` `maxLength: 20`
`alternate`	`extendedPhoneNumber(extended-phone-number)` The alternate phone number of the customer. This object is omitted if there is not an alternate phone number. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`fax`	`simplePhoneNumber(phone-number)` The fax number of the customer. This object is omitted if there is not a fax phone number. `format: phone-number` `minLength: 5` `maxLength: 20`

customerSessionItem

{
  "subjectId": "string",
  "sessionId": "string",
  "preferredUsername": "string",
  "displayName": "string",
  "startedAt": "2021-10-30T19:06:04.250Z",
  "expiresAt": "2021-10-30T19:06:04.250Z",
  "applicationId": "string"
}

Customer Session Item (v2.0.0)

A customer session within a list of sessions.

Properties

Name	Description
`Customer Session Item (v2.0.0)`	`object` A customer session within a list of sessions.
`subjectId`	`subjectId(text)` The customer's subject ID (`sub`) within the Identity Provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`sessionId`	`externalResourceId(text)` The logged in user's session ID (`sid`) within the Identity Provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`preferredUsername`	`string(text)` The customer/member's preferred username. `format: text` `maxLength: 50`
`displayName`	`string(text)` The customer name, for display purposes. `format: text` `maxLength: 100`
`startedAt`	`timestamp(date-time)` The timestamp when the session began, in RFC 3339 `date-time` UTC format `format: date-time` `minLength: 20` `maxLength: 30`
`expiresAt`	`timestamp(date-time)` The timestamp when the session expires, in RFC 3339 `date-time` UTC format `format: date-time` `minLength: 20` `maxLength: 30`
`applicationId`	`string(text)` The application name, type, or ID. `format: text` `maxLength: 64`

customerSessions

{
  "items": [
    {
      "subjectId": "string",
      "sessionId": "string",
      "preferredUsername": "string",
      "displayName": "string",
      "startedAt": "2021-10-30T19:06:04.250Z",
      "expiresAt": "2021-10-30T19:06:04.250Z",
      "applicationId": "string"
    }
  ]
}

Customer Sessions (v2.0.0)

Customer Sessions.

Properties

Name	Description
`Customer Sessions (v2.0.0)`	`object` Customer Sessions.
`items`	`array: [customerSessionItem]` The list of a customer's sessions. `maxItems: 1000` items: `object`

customerType

"commercial"

Customer Type (v1.0.0)

Indicates the type of digital banking customer/member.

type: string

enum values: commercial, retail

customerUsername

"string"

Customer Username (v2.1.0)

A customer's login username.

type: string(text)

format: text
minLength: 5
maxLength: 128

encryptedString

"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"

Encrypted String (v1.0.0)

A string value that has been encrypted using a public encryption key then Base64 encoded.

type: string

minLength: 120
maxLength: 8096

encryptedWith

"string"

Encrypted With (v2.0.0)

The id of the public encryption key instance the client used to encrypt the data.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

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

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

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

invitationReference

{
  "redirect_url": "https://usermanagment.mybank.com/signup?ref=88991745-d4f5-48c8-bead-27d34e26da8a",
  "id": "88991745-d4f5-48c8-bead-27d34e26da8a"
}

Invitation Reference (v1.0.0)

Data representing an invitation sent (e.g. via email) or to redirect a customer that is currently interacting with the system.

Properties

Name	Description
`Invitation Reference (v1.0.0)`	`object` Data representing an invitation sent (e.g. via email) or to redirect a customer that is currently interacting with the system.
`redirect_url`	`string(uri)` (required) The invitation redirect URL. This is the URL that the customer will either be immediately redirected to when currently interacting with the application or the URL to be included in an email invitation. The application handling this URL completes the customer registration via `convertCandidateToBankingCustomer`. `format: uri` `maxLength: 400`
`id`	`resourceId` (required) The unique ID of the invitation. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

ipAddressAndPort

"string"

IP Address and Port (v1.0.0)

The IP Address, in the IPv4 (RFC 6864) or IPv6 (RFC 8200) format, and source port of the request client.

If the IP address is in the IPv4 format, the address and source port are separated by a colon.

For example, a value of 198.51.100.10:46532 means the viewer's IP address is 198.51.100.10 and the request source port is 46532.

If the IP address is in the IPv6 format, the address is enclosed in square brackets, and the source port follows after a colon.

For example, a value of [2a00:1397:4:2a02::a1]:50434 means the viewer's IP address is 2a00:1397:4:2a02::a1 and the request source port is 50434.

type: string

pattern: "^(?:[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]{1,5}$|^\[?[A-Fa-f0-9:]+\]?:[0-9]{1,5}$|^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$|^\[?[A-Fa-f0-9:]+\]?$"

matchingBankingCustomerItem

{
  "id": "3a6b72311531ffc64d42",
  "coreCustomerId": "0964e98c6edeab9dc098",
  "username": "peck_plumbing",
  "name": "Max Peck",
  "type": "retail",
  "state": "enabled",
  "scope": "person",
  "taxId": "112223333",
  "enrollmentState": "enrolled",
  "referenceId": "1499",
  "institutionId": "TIBURON",
  "emailAddresses": {
    "primary": "Max.Pike@example.com",
    "secondary": "MaxwellPike@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "+19105550150"
  },
  "authenticationChallengeFactors": [
    {
      "type": "email",
      "email": {
        "primary": true,
        "secondary": false
      }
    },
    {
      "type": "sms",
      "sms": {
        "primary": false,
        "secondary": false,
        "mobile": true,
        "alternate": false
      }
    },
    {
      "type": "voice",
      "voice": {
        "primary": false,
        "secondary": false,
        "mobile": true,
        "alternate": false
      }
    }
  ]
}

Matching Banking Customer Item (v3.0.0)

A Banking Customer that matched the search criteria.

Properties

Name Description

Matching Banking Customer Item (v3.0.0) object
A Banking Customer that matched the search criteria.

id readOnlyResourceId (required)
The resource ID of the banking customer.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

name string(text) (required)
The full name of the customer.
format: text
minLength: 1
maxLength: 50

emailAddresses customerEmailAddresses (required)
The customer's email addresses.

phoneNumbers customerPhoneNumbers (required)
The customer's phone numbers.

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

state

bankingCustomerState (required)

Banking Customer State.

bankingCustomerState strings may have one of the following enumerated values:

Value	Description
`enabled`	Enabled: An active banking customer for which digital banking is enabled.
`disabled`	Disabled: A banking customer for which digital banking is disabled.
`locked`	Locked: The financial institution has locked the customer, preventing all new banking activity.

enum values: enabled, disabled, locked

scope bankingCustomerScope
Indicates the scope of a banking customer's relationship with digital banking.
enum values: person, unknown

enrollmentState

bankingCustomerEnrollmentState (required)

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

referenceId

string (required)
A short ID value that allows administrative application users to reference and look up customers.

institutionId institutionId (required)
The unique identifier of the financial institution.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

username

customerUsername(text) (required)
A customer's login username.

In responses, this property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

matchingBankingCustomers

{
  "items": [
    {
      "id": "3a6b72311531ffc64d42",
      "coreCustomerId": "0964e98c6edeab9dc098",
      "username": "peck_plumbing",
      "name": "Max Peck",
      "type": "retail",
      "state": "enabled",
      "scope": "person",
      "taxId": "112223333",
      "enrollmentState": "enrolled",
      "referenceId": "1499",
      "institutionId": "TIBURON",
      "emailAddresses": {
        "primary": "Max.Pike@example.com",
        "secondary": "MaxwellPike@me.example.com"
      },
      "phoneNumbers": {
        "primary": "+19105550155",
        "mobile": "+19105550150"
      },
      "authenticationChallengeFactors": [
        {
          "type": "email",
          "email": {
            "primary": true,
            "secondary": false
          }
        },
        {
          "type": "sms",
          "sms": {
            "primary": false,
            "secondary": false,
            "mobile": true,
            "alternate": false
          }
        },
        {
          "type": "voice",
          "voice": {
            "primary": false,
            "secondary": false,
            "mobile": true,
            "alternate": false
          }
        }
      ]
    }
  ]
}

Matching Banking Customers (v3.0.0)

Banking customers which match the search criteria.

Properties

Name	Description
`Matching Banking Customers (v3.0.0)`	`object` Banking customers which match the search criteria.
`items`	`array: [matchingBankingCustomerItem]` (required) A list of customers which match the search criteria. An empty array means no customers matched. `maxItems: 10` items: `object`

migratedBankingCustomer

{
  "subjectId": "string"
}

Migrated Banking Customer (v1.0.0)

Request body to mark a banking customer identity as migrated.

Properties

Name	Description
`Migrated Banking Customer (v1.0.0)`	`object` Request body to mark a banking customer identity as migrated.
`subjectId`	`subjectId(text)` (required) The Subject ID of an identity or actor within the financial institution's identity provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`

newBankingCustomer

{
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "password": "Peter-Piper-picked-a-peck-plumber-7771",
  "taxId": "112223333",
  "name": "Max Peck",
  "nickname": "Max",
  "alternateName": "Maxwell Peck",
  "type": "commercial",
  "birthdate": "2002-10-31",
  "enrollmentState": "enrolled",
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "9105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "employee": "notAnEmployee",
  "electronicStatementElectionDefault": true,
  "electronicDocumentElectionDefault": true,
  "identitySource": "digitalBanking"
}

New Banking Customer (v7.0.0)

Request body to create a new banking customer.

Properties

Name Description

New Banking Customer (v7.0.0) object
Request body to create a new banking customer.

enrollmentState

bankingCustomerEnrollmentState (required)

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

username customerUsername(text)
A customer's login username. This property may be masked (some character sequences replaced with *) unless unmasked data is requested.
format: text
minLength: 5
maxLength: 128

subjectId subjectId(text)
The customer's subject ID in the financial institution's identity provider.
read-only
format: text
minLength: 1
maxLength: 256

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

name string(text) (required)
The customer or member's full name as used in banking systems.
format: text
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

nickname string(text)
The customer's nickname or greeting name; only present if the customer has assigned their nickname.
format: text
minLength: 1
maxLength: 20

employee

bankingCustomerInstitutionEmployeeState (required)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

contactCard newBankingCustomerContactCard (required)
The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true.

password string(text)
The customer login password.
write-only
format: text
minLength: 6
maxLength: 48

identitySource

bankingCustomerIdentitySource (required)

Indicates where the customer's login/authentication identity originated.

bankingCustomerIdentitySource strings may have one of the following enumerated values:

Value	Description
`digitalBanking`	Digital Banking: The customer identity originated in the digital banking platform.
`external`	External: The customer identity originated in an external identity provider.
`pendingExternal`	Pending External: The customer identity is pending from an external identity provider.

enum values: digitalBanking, external, pendingExternal

newBankingCustomerAddresses

{
  "primary": {
    "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 Customer Addresses (v2.0.0)

Postal addresses for a new banking customer.

Properties

Name	Description
`New Banking Customer Addresses (v2.0.0)`	`object` Postal addresses for a new banking customer.
`primary`	`requestAddress` (required) The customer's primary address. For individuals, this is their home address. For businesses, this is the company's business address.
`mailing`	`requestAddress` The customer's mailing address. If present, financial institution sends statements and other documents to this address instead of the `primary` address.

newBankingCustomerContactCard

{
  "addresses": {
    "primary": {
      "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": "Max.Peck@example.com",
    "secondary": "MaxwellPeck@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "9105550150"
  }
}

New Banking Customer Contact Card (v3.0.0)

A new banking customer's contact information.

Properties

Name	Description
`New Banking Customer Contact Card (v3.0.0)`	`object` A new banking customer's contact information.
`addresses`	`newBankingCustomerAddresses` (required) The customer's postal addresses.
`emailAddresses`	`newBankingCustomerEmailAddresses` (required) The customer's email addresses.
`phoneNumbers`	`newBankingCustomerPhoneNumbers` (required) The customer's phone numbers.

newBankingCustomerEmailAddresses

{
  "primary": "Max.Peck@example.com",
  "secondary": "MaxwellPeck@me.example.com"
}

New Banking Customer Email Addresses (v1.1.1)

Email addresses for a new banking customer.

Properties

Name	Description
`New Banking Customer Email Addresses (v1.1.1)`	`object` Email addresses for a new banking customer.
`primary`	`customerEmailAddress(email)` (required) The primary email address of the customer. `format: email` `maxLength: 255`
`secondary`	`customerEmailAddress(email)` The secondary email address of the customer. This value is omitted if there is not a secondary email address. `format: email` `maxLength: 255`

newBankingCustomerPhoneNumbers

{
  "primary": "+19105550155",
  "mobile": "9105550150"
}

New Banking Customer Phone Numbers (v2.0.0)

Phone Numbers for a new banking customer.

Properties

Name	Description
`New Banking Customer Phone Numbers (v2.0.0)`	`object` Phone Numbers for a new banking customer.
`primary`	`extendedPhoneNumber(extended-phone-number)` (required) The primary phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`secondary`	`extendedPhoneNumber(extended-phone-number)` The secondary phone number of the customer. This value is omitted if there is not a secondary phone number. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`mobile`	`string` The mobile phone number of the customer. This number may be used for SMS (text message) communication to customer if the user has opted in for SMS communication, so it must be a 10 digit US mobile number. This value is omitted if there is not a mobile phone number. `minLength: 10` `maxLength: 10` `pattern: "^\\d{10}$"`
`alternate`	`extendedPhoneNumber(extended-phone-number)` The alternate phone number of the customer. This value is omitted if there is not an alternate phone number. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`fax`	`extendedPhoneNumber(extended-phone-number)` The fax number of the customer. This value is omitted if there is not a fax phone number. `format: extended-phone-number` `minLength: 5` `maxLength: 20`

newCandidateCustomer

{
  "firstName": "Phil",
  "lastName": "Duciary",
  "emailVerified": true,
  "phoneNumberVerified": true,
  "phoneNumberChannel": "sms",
  "connectedIdentifiers": [
    {
      "systemName": "loanUnderwritingPortal",
      "identifier": "8d67ccfaac3cd1262dbd"
    }
  ],
  "identityVerified": true,
  "candidateType": "customer",
  "timeZoneId": "America/New_York",
  "name": "Phil Duciary",
  "alternateName": "Philip K. Duciary",
  "coreCustomerId": "3392c022c74aad2bb8e5",
  "nickname": "Max",
  "enrollmentState": "enrolled",
  "type": "retail",
  "middleName": "K.",
  "contactCard": {
    "phoneNumbers": {
      "primary": "+1919555-1234"
    },
    "emailAddresses": {
      "primary": "phil.duciary@example.com"
    }
  },
  "taxId": "111223333",
  "birthdate": "2003-08-24",
  "employee": "notAnEmployee",
  "electronicDocumentElectionDefault": true,
  "electronicStatementElectionDefault": true,
  "allows": {
    "createNewLoginCredentials": true,
    "connectToExistingCustomerIdentity": false
  }
}

New Candidate Customer (v8.0.0)

This customer profile data allows the system and/or the financial institution's identity provider to prepare a new banking customer record for a candidate (potential) customer, or to find an existing banking customer.

Properties

Name Description

New Candidate Customer (v8.0.0) object
This customer profile data allows the system and/or the financial institution's identity provider to prepare a new banking customer record for a candidate (potential) customer, or to find an existing banking customer.

name string(text) (required)
The customer or member's full name as used in banking systems.
format: text
maxLength: 50

alternateName string(text)
An alternate name for the customer.
format: text
minLength: 1
maxLength: 50

type customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail

enrollmentState

bankingCustomerEnrollmentState (required)

A banking customer's state of enrollment in digital banking.

bankingCustomerEnrollmentState strings may have one of the following enumerated values:

Value	Description
`pendingApplicant`	Pending Applicant: A customer who has applied to open an account but is not yet approved and is still pending in digital banking. The customer can only login to the digital account opening application.
`pendingEnrollment`	Pending Enrollment: A customer who has started self-service enrollment but who is not yet approved and is still pending in digital banking.
`enrolled`	Enrolled: A customer enrolled in digital banking, set as active and enabled.

enum values: pendingApplicant, pendingEnrollment, enrolled

firstName string(text)
The customer or member's first name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

middleName string(text)
The customer or member's middle name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

lastName string(text)
The customer or member's last (or family) name. Deprecated: use name instead.
format: text
deprecated: true
maxLength: 80

contactCard newCandidateCustomerContactCard (required)
The contact information for the customer.

emailVerified boolean (required)
The customer or member's primary email address has been verified.

phoneNumberVerified boolean (required)
The customer or member's phone number has been verified.

phoneNumberChannel phoneNumberChannel
Indicates the mobile phone communication method (channel) used by the identity provider.
default: "sms"
enum values: sms, voice

connectedIdentifiers array: [connectedIdentifier]
A list of systems where the customer or member has a registered identity.
maxItems: 80
items: object

identityVerified boolean
true if an only if the caller has verified the customer or member's identity on a trusted core or other system.

candidateType

candidateCustomerType (required)

A candidate customer banking customer type.

candidateCustomerType strings may have one of the following enumerated values:

Value	Description
`customer`	Customer: Existing customer or member of the financial institution.
`applicant`	Applicant: Applicant, prospect or other non-customer
`employee`	Employee: An employee or agent of the financial institution

enum values: customer, applicant, employee

timeZoneId timeZoneId(text)
The customer's preferred time zone.
format: text
maxLength: 36

birthdate string(date)
The customer's date of birth formatted in YYYY-MM-DD RFC 3339 date UTC format.
format: date
minLength: 10
maxLength: 10
pattern: "^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$"

nickname string(text)
If included, the customer's nickname or greeting name.
format: text
minLength: 1
maxLength: 20

employee

bankingCustomerInstitutionEmployeeState (required)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

Value	Description
`employee`	Employee: This banking customer is currently a current employee of the financial institution.
`notAnEmployee`	Not an Employee: This banking customer is not a current employee of the financial institution.
`unknown`	Unknown: The banking customer's employee status with the financial institution is unknown.

enum values: employee, notAnEmployee, unknown

allows candidateCustomerAllows
Indicates allowed operations for a candidate customer.

newCandidateCustomerContactCard

{
  "addresses": {
    "primary": {
      "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": "Max.Peck@example.com",
    "secondary": "MaxwellPeck@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "9105550150"
  }
}

New Candidate Customer Contact Card (v3.0.0)

A new candidate customer's contact information.

Properties

Name	Description
`New Candidate Customer Contact Card (v3.0.0)`	`object` A new candidate customer's contact information.
`addresses`	`newBankingCustomerAddresses` The customer's postal addresses.
`emailAddresses`	`newBankingCustomerEmailAddresses` (required) The customer's email addresses.
`phoneNumbers`	`newBankingCustomerPhoneNumbers` (required) The customer's phone numbers.

oauth2Error

{
  "error": "invalid_request",
  "error_description": "string"
}

OAuth2 Error (v1.0.0)

OAuth2 Error as per RFC 6749.

Properties

Name	Description
`OAuth2 Error (v1.0.0)`	`object` OAuth2 Error as per RFC 6749.
`error`	`oauth2ErrorType` (required) An identifier which conveys what error occurred. enum values: `invalid_request`, `unauthorized_client`, `access_denied`, `unsupported_response_type`, `invalid_scope`, `server_error`, `temporarily_unavailable`
`error_description`	`string(text)` Human-readable description of the error. `format: text` `maxLength: 400` `pattern: "^[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]{1,400}$"`

oauth2ErrorType

"invalid_request"

OAuth2 Error Type (v1.0.0)

OAuth2 Error Type.

type: string

enum values: invalid_request, unauthorized_client, access_denied, unsupported_response_type, invalid_scope, server_error, temporarily_unavailable

phoneNumberChannel

"sms"

Phone Number Channel (v1.0.0)

Indicates the mobile phone communication method (channel).

phoneNumberChannel strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: Short Message Service, for mobile text (SMS) messages
`voice`	Voice: Voice calls

type: string

enum values: sms, voice

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

API problem or error response, as per RFC 9457 application/problem+json.

Properties

Name	Description
`Problem Response (v0.4.2)`	`object` API problem or error response, as per RFC 9457 application/problem+json.
`type`	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `format: uri-reference` `maxLength: 2048`
`title`	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. `format: text` `maxLength: 120`
`status`	`integer(int32)` The HTTP status code for this occurrence of the problem. `format: int32` `minimum: 100` `maximum: 599`
`detail`	`string(text)` A human-readable explanation specific to this occurrence of the problem. `format: text` `maxLength: 256`
`instance`	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `format: uri-reference` `maxLength: 2048`
`id`	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`occurredAt`	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`problems`	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128` items: `object`
`attributes`	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

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

requestAddress

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

Request Address (v1.0.0)

A postal address that can hold a US address or an international (non-US) postal address. Address lines are limited to 30 characters.

Properties

Name	Description
`Request Address (v1.0.0)`	`object` A postal address that can hold a US address or an international (non-US) postal address. Address lines are limited to 30 characters.
`address1`	`string(text)` (required) The first line of the postal address. In the US, this typically includes the building number and street name. `format: text` `maxLength: 30`
`address2`	`string(text)` The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address. `format: text` `maxLength: 30`
`locality`	`string(text)` (required) The city/town/municipality of the address. `format: text` `maxLength: 30`
`countryCode`	`countryCode` (required) The ISO-3611 alpha-2 value for a country. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`regionName`	`string(text)` The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive. `format: text` `minLength: 2` `maxLength: 20`
`regionCode`	`string` The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`postalCode`	`postalCode` (required) 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. `minLength: 2` `maxLength: 20` `pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"`

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

responseAddress

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

Response Address (v1.0.0)

A postal address that can hold a US address or an international (non-US) postal address, returned in API responses. Address lines are limited to 35 characters but actual address lines will be at most 30 characters.

Properties

Name	Description
`Response Address (v1.0.0)`	`object` A postal address that can hold a US address or an international (non-US) postal address, returned in API responses. Address lines are limited to 35 characters but actual address lines will be at most 30 characters.
`address1`	`string(text)` (required) The first line of the postal address. In the US, this typically includes the building number and street name. `format: text` `maxLength: 35`
`address2`	`string(text)` The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address. `format: text` `maxLength: 35`
`locality`	`string(text)` (required) The city/town/municipality of the address. `format: text` `maxLength: 30`
`countryCode`	`countryCode` (required) The ISO-3611 alpha-2 value for a country. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`regionName`	`string(text)` The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive. `format: text` `minLength: 2` `maxLength: 20`
`regionCode`	`string` The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`postalCode`	`postalCode` (required) 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. `minLength: 2` `maxLength: 20` `pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"`

retailBankingCustomer

{
  "birthdate": "2000-01-01"
}

Retail Banking Customer (v1.0.2)

Properties of retail banking customers.

Properties

Name	Description
`Retail Banking Customer (v1.0.2)`	`object` Properties of retail banking customers.
`birthdate`	`string(text)` The customer's date of birth. This property may be masked (some digits replaced with ``) unless unmasked data is requested. `format: text` `minLength: 10` `maxLength: 10` `pattern: "^(19\|20\|\\\\)[0-9]{2}-[0-9]{2}-[0-9]{2}$"`

sessionTerminationRequest

{
  "logout_token": "string"
}

Session Termination Request (v1.0.0)

Session Termination Request.

Properties

Name	Description
`Session Termination Request (v1.0.0)`	`object` Session Termination Request.
`logout_token`	`string(text)` (required) A logout token that identifies the user session to logout/terminate as per OpenID Connect Back-Channel Logout Request. `format: text` `maxLength: 4000`

simplePhoneNumber

"+19105550155"

Simple Phone Number (v1.1.0)

The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more *, such as *1234.

type: string(phone-number)

format: phone-number
minLength: 5
maxLength: 20

subjectId

"string"

Subject Id (v1.0.0)

The Subject ID of an identity or actor within the financial institution's identity provider.

type: string(text)

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

timeZoneId

"America/New_York"

Time Zone Identifier or Offset (v1.3.0)

A time zone. This may be either a time zone identifier/TZ Identifier (as described by RFC 7808) in the list of time zones, or a time zone offset from UTC in the form [-+]HH:MM. Localized abbreviations, such as EST and EDT, are also allowed.

type: string(text)

format: text
maxLength: 36

timestamp

"2021-10-30T19:06:04.250Z"

Timestamp (v1.0.0)

A timestamp (an instant in time) formatted in YYYY-MM-DDThh:mm:ss.sssZ RFC 3339 date-time UTC format.

type: string(date-time)

format: date-time
minLength: 20
maxLength: 30

Generated by @apiture/api-doc 3.2.4 on Wed Nov 05 2025 20:05:37 GMT+0000 (Coordinated Universal Time).