Account Applications Administration v0.5.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.
List and view customer's new account and join owner applications for administrative applications.
- Use
listCustomerAccountApplicationsto list customer applications, with filters to select applications in date ranges, applications by type, by applicant or organization name, or by application state.
Download OpenAPI Definition (YAML)
Base URLs:
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. |
Customer Account Applications
Customer Account Applications
listCustomerAccountApplications
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAccountApplications \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/customerAccountApplications 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/customerAccountApplications',
{
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/customerAccountApplications',
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/customerAccountApplications',
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/customerAccountApplications', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAccountApplications");
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/customerAccountApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of customer account applications
GET https://api.apiture.com/bankingAdmin/customerAccountApplications
Return a paginated collection of customer account applications. The nextPage_url in the response is a pagination link. The result is sorted in reverse chronological order.
Parameters
| Parameter | Description |
|---|---|
creationPeriodin: query | string(duration) Return only applications which have been created within this period of time before the present time. The value is an ISO 8601 duration string. For example, for ?creationPeriod=P1D or ?creationPeriod=PT24H, return applications created in the past day (24 hours). Use ?creationPeriod=P2W to list applications created within the last 2 weeks. If the present time is 16:30PM, use ?creationPeriod=PT16H30M to list all applications created since midnight, or ?creationPeriod=P1DT16H30M to list all applications created since midnight yesterday. This parameter is mutually exclusive of createdAt.format: duration minLength: 3 maxLength: 30 |
createdAtin: query | dateTimeRange Filter the response to only applications created in the date-time range bounded by start and end date-times. This parameter is mutually exclusive of creationPeriod. The start and end values are either dates in RFC 3339 YYYY-MM-DD date format, or date-times in YYYY-MM-DDThh:mm:ss.sssZ date-time format. For example
Dates without a time component are converted to UTC date-time values. If start or end are date values, then start00 is defined as time 00:00:00Z on the start date, start24 is defined as 00:00AM of the day after the start date: end00 is defined as time 00:00:00Z on the end date, end24 is defined as 00:00AM of the day after the end date:
For example, the range If creationPeriod.format: text minLength: 10 maxLength: 63 pattern: "^((\\d{4}-\\d{2}-\\d{2})|([[(](((\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?),(\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?)?)|(,(\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?)))[)\\]]))$" |
namein: query | string(text) Return only applications whose applicant first name, applicant last name, or organization name matches this value or contains this value. format: text minLength: 2 maxLength: 80 |
statein: query | array[string] Return only applications whose state is in this list of states.unique items minItems: 1 maxItems: 7 pipe-delimited items: string» enum values: pending, running, blocked, canceled, expired, rejected, approved |
customerTypein: query | applicationCustomerType Return only applications where the account's customer type matches this value. enum values: personal, business |
startin: query | string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url.maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$" |
limitin: query | integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 100 default: 50 |
Example responses
200 Response
{
"start": "d1b48af913464aa49fcb07065dcc0616",
"limit": 10,
"nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAccountApplications?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
"items": [
{
"id": "0399abed-fd3d",
"type": "newAccount",
"state": "blocked",
"products": [
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
],
"flaggedForReview": true,
"hasUnresolvedProblems": true,
"applicant": {
"id": "97fd7e918b7ae6588b4b",
"firstName": "Elsa",
"lastName": "Snowqueen"
},
"organization": {
"id": "21ae7ee4af1e786f2be4",
"legalName": "Max Peck Mobile Repair"
},
"account": {
"name": "My June CD"
},
"approvals": [],
"reviewer": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"assignee": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
}
}
]
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| OK. | |
Schema: customerAccountApplications |
| Status | Description |
|---|---|
| 400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getCustomerAccountApplication
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAccountApplications/{accountApplicationId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/customerAccountApplications/{accountApplicationId} 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/customerAccountApplications/{accountApplicationId}',
{
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/customerAccountApplications/{accountApplicationId}',
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/customerAccountApplications/{accountApplicationId}',
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/customerAccountApplications/{accountApplicationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAccountApplications/{accountApplicationId}");
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/customerAccountApplications/{accountApplicationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this customer account application
GET https://api.apiture.com/bankingAdmin/customerAccountApplications/{accountApplicationId}
Return the JSON representation of this customer account application resource.
Parameters
| Parameter | Description |
|---|---|
accountApplicationIdin: path | readOnlyResourceId (required) The unique ID of a banking customer's account application. This is the id property of the application.read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"type": "newAccount",
"state": "blocked",
"products": [
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
],
"flaggedForReview": true,
"hasUnresolvedProblems": true,
"reviewer": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"id": "0399abed-fd3d",
"applicant": {
"id": "6fed31a71850ae9b287d",
"username": "elsa_332",
"firstName": "Elsa",
"lastName": "Snowqueen",
"birthdate": "1995-01-30",
"role": {
"name": "Primary Account Holder"
},
"verification": {
"provider": "IDology",
"sessionId": "c97671fc-b658-4c15-a1c8-819e691b7d3c",
"scoredAt": "2023-01-13T13:28:59.375Z",
"score": "passed",
"result": "verified",
"verifications": [
{
"type": "fraudRiskReport",
"state": "passed",
"createdAt": "2023-01-12T10:15:17Z"
},
{
"type": "quiz",
"state": "passed",
"createdAt": "2023-01-12T10:19:41Z"
}
]
},
"attested": true,
"contactCard": {
"phoneNumbers": {
"primary": "+19105551234",
"primaryExtension": "337"
},
"emailAddress": "elsa.snowqueen@example.com",
"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"
},
"yearsAtPrimaryAddress": "fourOrMore"
}
},
"dueDiligenceAnswers": {
"bankingPurpose": "operational funds",
"citizen": true,
"foreignPoliticalFigure": false,
"familyOfPoliticalFigure": false,
"w9Withholdings": false,
"primaryIncomeSource": "wages",
"internationalTransfers": false,
"identification": {
"type": "driversLicense",
"number": "****1234",
"issuingAuthority": "NC",
"issuedOn": "2018-01-30",
"expiresOn": "2026-01-29"
},
"employment": {
"status": "fullTime",
"currentEmployerName": "Max Peck Towing",
"occupation": "accountant",
"currentJobTitle": "Chief Accountant"
}
}
},
"organization": {
"id": "638ae35cbe5b7e0baa40",
"legalName": "Max Peck Towing, LLC",
"doingBusinessAs": "Max Peck Towing",
"taxId": "112-22-3333",
"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"
}
},
"emailAddress": "Max.Pike@example.com",
"phoneNumbers": {
"primary": "+19105550155"
},
"home_url": "http://max-peck-towing.example.com"
},
"approvals": [
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "rejected",
"done": true,
"reason": "Invalid U.S. Address",
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
],
"industrySector": "otherServices",
"countryOfOperations": "US",
"registeredIn": "NC",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"estimatedAnnualRevenue": "under1Million",
"regulatory": {
"atmOperator": false,
"charity": false,
"internetGambling": false,
"marijuanaBusiness": false,
"subjectToWithholdings": false,
"intermediaryServices": []
},
"physicalLocationsCount": "from10to50",
"legalStructure": "soleProprietorship",
"estimatedMonthlyAmounts": {
"achTransactions": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "oneHundredThousandToOneMillion",
"remoteCheckDeposit": "oneHundredThousandToOneMillion",
"wireTransfers": "oneHundredThousandToOneMillion"
},
"estimatedMonthlyCounts": {
"achTransactions": "oneHundredOneToOneThousand",
"mobileCheckDeposit": "oneHundredOneToOneThousand",
"remoteCheckDeposit": "oneHundredOneToOneThousand",
"wireTransfers": "oneToOneHundred"
},
"beneficialOwners": [
{
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "112-22-3333",
"percentage": 35
}
],
"updatedAt": "2023-10-24T06:26:53.375Z"
},
"approvals": [
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "approved",
"done": true,
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe/content",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
],
"assignee": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"documents": [
{
"type": "governmentId",
"contentType": "application/pdf",
"documentTarget": "business",
"category": "driversLicense",
"uri": "https://production.api.apiture.com/vault/7d0e5c70-6efd-4d7e-84c8-d62335227080/content"
},
{
"type": "articlesOfOrganization",
"contentType": "application/pdf",
"documentTarget": "business",
"category": "articlesOfOrganization",
"uri": "https://production.api.apiture.com/vault/642c977e-4f24-4d7e-bccc-7e275fbfc415/content"
}
],
"funding": {
"maskedNumber": "*1234",
"routingNumber": "123123123",
"institutionName": "Third Party Bank",
"location": "external",
"type": "checking",
"verificationMethod": "instant",
"fundingAmount": {
"value": "1000.00",
"currency": "USD"
},
"authorization": {
"granted": true,
"grantedAt": "2024-02-01T05:58:21.375Z",
"message": "I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789."
}
},
"debitCardRequest": {
"cardholderName": "John Smith",
"requested": true,
"shippingAddress": {
"address1": "P.O. Box 1805",
"locality": "Wilmington",
"regionCode": "NC",
"countryCode": "US",
"postalCode": "28412"
}
},
"account": {
"maskedNumber": "*6789",
"accountNumber": "123456789"
},
"createdAt": "2023-10-15T06:16:36.375Z",
"submittedAt": "2023-10-16T16:42:50.375Z",
"reviewedAt": "2023-10-17T06:22:27.375Z",
"trackingIds": [
{
"id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
"createdAt": "2021-06-07T09:11:02.375Z"
}
],
"notes": [
{
"id": "0399abed-fd3d",
"text": "Please review this fraud report.",
"createdAt": "2023-04-19T10:49:28.375Z",
"creator": {
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings",
"state": "active"
},
"attachments": [
{
"id": "0399abed-fd3d",
"name": "fraud-report-389398.pdf",
"contentType": "application/pdf",
"url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
"contentLength": 276000
}
]
}
]
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| OK. | |
Schema: customerAccountApplication |
| Status | Description |
|---|---|
| 400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
| Status | Description |
|---|---|
| 404 | Not Found |
Not Found. There is no such customer account application resource at the specified {accountApplicationId}. | |
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 error response may have one of the following
| |
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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | 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.1) | API problem or error response, as per RFC 9457 application/problem+json. |
| » type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120 |
| » status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
| » detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
| » instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
| » occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
| » attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Schemas
accountApplicantReference
{
"id": "97fd7e918b7ae6588b4b",
"firstName": "Elsa",
"lastName": "Snowqueen"
}
Account Applicant Reference (v1.0.0)
Describes the person who is applying for an account.
Properties
| Name | Description |
|---|---|
Account Applicant Reference (v1.0.0) | Describes the person who is applying for an account. |
id | The ADB customer ID of the applicant. read-only format: text maxLength: 48 |
firstName | The first name of the applicant. format: text minLength: 1 maxLength: 128 |
lastName | The last name of the applicant. format: text minLength: 1 maxLength: 128 |
accountApplicationFunding
{
"maskedNumber": "*1234",
"routingNumber": "123123123",
"institutionName": "Third Party Bank",
"location": "external",
"type": "checking",
"verificationMethod": "instant",
"fundingAmount": {
"value": "1000.00",
"currency": "USD"
},
"authorization": {
"granted": true,
"grantedAt": "2024-02-01T05:58:21.375Z",
"message": "I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789."
}
}
Account Application Funding (v1.2.0)
Describes how the new account is funded.
Properties
| Name | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Account Application Funding (v1.2.0) | Describes how the new account is funded. | ||||||||||||||
accountNumber | A full account number. This is the number that the customer uses to reference the account within the financial institution. This property is present only if the caller requests unmasked data. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$" | ||||||||||||||
maskedNumber | A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$" | ||||||||||||||
routingNumber | An account ABA routing and transit number. minLength: 9 maxLength: 9 pattern: "^[0-9]{9}$" | ||||||||||||||
institutionName | The name of the financial institution where the funding account is held. format: text minLength: 2 maxLength: 128 | ||||||||||||||
location | Indicates where an account is held:
enum values: internal, external, outside | ||||||||||||||
type | The type (or category) of banking product.
enum values: savings, checking, cd, ira, loan, creditCard | ||||||||||||||
verificationMethod | Indicates how an external account was verified: micro deposits or IAV (Instant Account Verification). enum values: instant, microDeposit | ||||||||||||||
fundingAmount | How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. This is optional and omitted in responses if not set when the application is created or updated. | ||||||||||||||
authorization | The applicant's authorization for funding the new account. |
accountApplicationFundingAuthorization
{
"granted": true,
"grantedAt": "2024-02-01T05:58:21.375Z",
"message": "I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789."
}
Account Application Funding Authorization (v1.0.0)
The applicant's authorization for funding the new account.
Properties
| Name | Description |
|---|---|
Account Application Funding Authorization (v1.0.0) | The applicant's authorization for funding the new account. |
granted | true if and only if the user has explicitly granted funding authorization. |
grantedAt | The date and time the user granted the funding authorization. Present only if granted is true.read-only format: date-time minLength: 20 maxLength: 30 |
message | The message presented to the user when they granted the funding authorization. Present only if granted is true.format: text maxLength: 1000 |
accountLocation
"internal"
Account Location (v1.0.0)
Indicates where an account is held:
internalaccounts at the current financial institution;externalaccounts at another financial institution;outsideaccounts non-banking accounts such as brokerage and fund accounts. Account transfers are only allowed betweeninternalandexternalaccounts. All accounts are considered when calculating total cash balance.
type: string
enum values: internal, external, outside
accountRoutingNumber
"123123123"
Account Routing Number (v1.0.0)
An account ABA routing and transit number.
type: string
minLength: 9 maxLength: 9 pattern: "^[0-9]{9}$"
address
{
"address1": "1805 Tiburon Dr.",
"address2": "Building 14, Suite 1500",
"locality": "Wilmington",
"regionCode": "NC",
"countryCode": "US",
"postalCode": "28403"
}
Address (v1.6.0)
A postal address that can hold a US address or an international (non-US) postal addresses.
Properties
| Name | Description |
|---|---|
Address (v1.6.0) | A postal address that can hold a US address or an international (non-US) postal addresses. |
address1 | The first line of the postal address. In the US, this typically includes the building number and street name. format: text maxLength: 35 |
address2 | 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 | The city/town/municipality of the address. format: text maxLength: 30 |
countryCode | The ISO-3611 alpha-2 value for the country associated with the postal address. minLength: 2 maxLength: 2 pattern: "^[A-Za-z]{2}$" |
regionName | 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 | 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 | The postal code, which varies in format by country. If countryCode is 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]" |
adminNoteAttachmentItem
{
"id": "0399abed-fd3d",
"name": "fraud-report-389398.pdf",
"contentType": "application/pdf",
"url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
"contentLength": 276000
}
Admin Note Attachment Item (v1.0.0)
Summary representation of an admin note attachment in a list of admin note attachments.
Properties
| Name | Description |
|---|---|
Admin Note Attachment Item (v1.0.0) | Summary representation of an admin note attachment in a list of admin note attachments. |
name | The name of this attachment. format: text maxLength: 128 |
contentType | The content type (media type) of the attachment. Media types with * wildcards are not allowed.minLength: 8 maxLength: 191 pattern: "^[-a-z0-9]{4,48}\\/[-+a-z0-9.]{3,142}$" enum values: text/plain, image/bmp, image/gif, image/png, image/jpeg, image/tiff, application/msword, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document |
url | The URL of the attachment. This URL should be directly viewable by admin users without requiring an additional Authorization or other request headers.format: uri maxLength: 2048 |
id | The unique identifier for this admin note attachment resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
contentLength | The content length (size in bytes) of the attachment. read-only format: int32 minimum: 1 maximum: 100000000 |
adminNoteContentType
"text/plain"
Admin Note Content Type (v1.0.0)
The list of allowed content types for admin notes.
type: string
enum values: text/plain, image/bmp, image/gif, image/png, image/jpeg, image/tiff, application/msword, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document
adminNoteItem
{
"id": "0399abed-fd3d",
"text": "Please review this fraud report.",
"createdAt": "2023-04-19T10:49:28.375Z",
"creator": {
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings",
"state": "active"
},
"attachments": [
{
"id": "0399abed-fd3d",
"name": "fraud-report-389398.pdf",
"contentType": "application/pdf",
"url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
"contentLength": 276000
}
]
}
Admin Note Item (v1.0.0)
Summary representation of an admin note resource in admin notes collections. To fetch the full representation of this admin note, use the getAdminNote operation, passing this item's id field as the adminNoteId path parameter.
Properties
| Name | Description |
|---|---|
Admin Note Item (v1.0.0) | Summary representation of an admin note resource in admin notes collections. To fetch the full representation of this admin note, use the getAdminNote operation, passing this item's id field as the adminNoteId path parameter. |
text | The text of this note. format: text minLength: 2 maxLength: 400 |
createdAt | The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.read-only format: date-time minLength: 20 maxLength: 30 |
id | The unique identifier for this admin note resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
creator | Who created this note. |
attachments | array: Optional description of files attached to this note. This property is omitted if there are no attachments. Use the getAdminNoteAttachment with the attachment id to fetch its content.maxItems: 8 items: object |
adminUserReference
{
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings",
"state": "active"
}
Admin User Account Reference (v2.0.0)
The representation of an administrator user account for report filters.
Properties
| Name | Description |
|---|---|
Admin User Account Reference (v2.0.0) | The representation of an administrator user account for report filters. |
id | The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
firstName | The user's first name. format: text maxLength: 56 |
lastName | The user's last name. format: text maxLength: 56 |
username | The user's login name. format: text maxLength: 20 |
state | The current state of the admin user. enum values: active, locked, removed |
adminUserState
"active"
Admin User State (v1.0.0)
The current state of the admin user.
adminUserState strings may have one of the following enumerated values:
| Value | Description |
|---|---|
active | Active: The admin user is active |
locked | Locked: The admin user's account is locked |
removed | Removed: The admin user has been been removed from the system |
type: string
enum values: active, locked, removed
apiProblem
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists at the given account_url",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
API Problem (v1.2.1)
API problem or error, as per RFC 7807 application/problem+json.
Properties
| Name | Description |
|---|---|
API Problem (v1.2.1) | API problem or error, as per RFC 7807 application/problem+json. |
type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | 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 | 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 | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
applicantAddresses
{
"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"
}
}
Applicant Addresses (v1.0.0)
An applicant's postal addresses.
Properties
| Name | Description |
|---|---|
Applicant Addresses (v1.0.0) | An applicant's postal addresses. |
primary | The customer's primary address. For individuals, this is their home address. For businesses, this is the company's business address. |
yearsAtPrimaryAddress | The number of years the customer has been at their present home address, as of the date the user registered. This value may become stale over time. enum values: unknown, oneOrFewer, two, three, fourOrMore |
mailing | The customer's mailing address. If present, financial institution sends statements and other documents to this address instead of the primary address. |
previous | The customer's previous address. |
applicantContactCard
{
"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"
}
},
"emailAddress": "Max.Pike@example.com",
"phoneNumbers": {
"primary": "+19105550155",
"primaryExtension": "347",
"mobile": "+19105550150"
}
}
Customer Contact Card (v1.1.0)
A customer's contact information.
Properties
| Name | Description |
|---|---|
Customer Contact Card (v1.1.0) | A customer's contact information. |
firstName | The applicant's first name. format: text maxLength: 80 |
lastName | The applicant's last name. format: text maxLength: 80 |
middleName | The applicant's middle name. format: text maxLength: 80 |
suffix | A title or honorific suffix such as PhD or DDS. format: text maxLength: 20 |
addresses | The customer's postal addresses. |
emailAddress | The customer's email address. format: email maxLength: 255 |
phoneNumbers | The customer's phone numbers. |
applicantDueDiligenceAnswers
{
"bankingPurpose": "operational funds",
"citizen": true,
"foreignPoliticalFigure": false,
"familyOfPoliticalFigure": false,
"w9Withholdings": false,
"primaryIncomeSource": "wages",
"internationalTransfers": false,
"identification": {
"type": "driversLicense",
"number": "****1234",
"issuingAuthority": "NC",
"issuedOn": "2018-01-30",
"expiresOn": "2026-01-29"
},
"employment": {
"status": "fullTime",
"currentEmployerName": "Max Peck Towing",
"occupation": "accountant",
"currentJobTitle": "Chief Accountant"
}
}
Applicant Due Diligence Answers (v1.0.1)
Answers the applicant provided for "Know Your Customer" due diligence questions which allow financial institutions to conform to their Customer Identification Program. Some financial institutions may choose to not collect all of these answers.
Properties
| Name | Description |
|---|---|
Applicant Due Diligence Answers (v1.0.1) | Answers the applicant provided for "Know Your Customer" due diligence questions which allow financial institutions to conform to their Customer Identification Program. Some financial institutions may choose to not collect all of these answers. |
bankingPurpose | A reason the user gave for banking with the financial institution. This applies to all accounts they intend to open under this customer relationship. format: text minLength: 2 maxLength: 100 |
otherBankingPurpose | A reason the user gave for banking with the financial institution if they selected other for bankingPurpose. This applies to all accounts they intend to open under this customer relationship.format: text minLength: 2 maxLength: 100 |
citizen | true if this person is a US citizen. |
usResident | If citizen is false, this property indicates the applicant's US residency status. |
w9Withholdings | true if this person is a subject to backup W-9 Tax Withholdings. |
foreignPoliticalFigure | true if this person is a foreign senior political figure.default: false |
foreignPoliticalFigureCountry | If this person is a foreign senior political figure, this is the foreign country's ISO 3166-1 alpha-2 country code. This field is omitted if foreignPoliticalFigure is false.minLength: 2 maxLength: 2 pattern: "[A-Z][A-Z]" |
foreignPoliticalFigurePosition | If this person is foreign senior political figure, this is the position that figure holds in the foreign country. This field is omitted if foreignPoliticalFigure is false.format: text minLength: 2 maxLength: 100 |
familyOfPoliticalFigure | true if this person is an immediate family member or a close associate of a foreign senior political figure. |
familyOfPoliticalFigureCountry | If this person is an immediate family member or a close associate of political figure, this is the foreign country's ISO 3166-1 alpha-2 country code. This field is omitted if familyOfPoliticalFigure is false.minLength: 2 maxLength: 2 pattern: "^[A-Z][A-Z]$" |
foreignPoliticalFigureAssociation | If familyOfPoliticalFigureCountry is true, this is the type of association to the foreign senior political figure. This field is omitted if familyOfPoliticalFigure is false.enum values: unknown, closeAssociate, familyMember, none, other, notApplicable |
foreignPoliticalFigureAssociationPosition | If this person is an immediate family member or a close associate of a foreign senior political figure, this is the position that figure holds in the foreign country. This field is omitted if familyOfPoliticalFigure is false.format: text minLength: 2 maxLength: 100 |
primaryIncomeSource | The applicant's primary source of income. format: text maxLength: 40 |
otherPrimaryIncomeSource | The actual source if income if primaryIncomeSource is other.format: text minLength: 2 maxLength: 100 |
internationalTransfers | If true, the user affirmed they plan to use accounts at this financial institution to send or receive funds from foreign countries. |
internationalTransferCountries | If internationalTransfers is true, this is the list of country names. This field is omitted if internationalTransfers is false.format: text minLength: 4 maxLength: 500 |
identification | Applicant Identification. |
employment | Applicant Employment. |
applicantEmployment
{
"status": "unknown",
"occupation": "string",
"currentEmployerName": "string",
"currentJobTitle": "string",
"previousEmployerName": "string",
"previousJobTitle": "string"
}
Applicant Employment (v1.0.0)
Applicant Employment.
Properties
| Name | Description |
|---|---|
Applicant Employment (v1.0.0) | Applicant Employment. |
status | The applicant's employment status. enum values: unknown, fullTime, partTime, paidLeave, retired, unemployed, other, notApplicable |
occupation | An identifier naming the applicant's occupation. format: text maxLength: 40 |
currentEmployerName | The name of the applicant's current employer. This property is only applicable if the employmentStatus indicates employment (including on leave).format: text maxLength: 40 |
currentJobTitle | The applicant's current job title. This property is only applicable if the employmentStatus indicates employment (including on leave).format: text maxLength: 80 |
previousEmployerName | The name of the applicant's previous employer, if any. format: text maxLength: 40 |
previousJobTitle | The applicant's previous job title. format: text maxLength: 80 |
applicantEmploymentStatus
"unknown"
Applicant Employment Status (v1.0.0)
The applicant's employment status.
type: string
enum values: unknown, fullTime, partTime, paidLeave, retired, unemployed, other, notApplicable
applicantIdentification
{
"type": "driversLicense",
"number": "01234567",
"issuingAuthority": "NC",
"issuedOn": "2020-07-10",
"expiresOn": "2026-07-10"
}
Applicant Identification (v1.0.1)
Applicant Identification.
Properties
| Name | Description |
|---|---|
Applicant Identification (v1.0.1) | Applicant Identification. |
type | Indicates what type of state, government, or other authority issued identification used for a person's identification. This is a programmatic identifier, such as driversLicense, stateId, passport or militaryId, not a label.format: text maxLength: 32 |
number | The ID number on the government- or authority- issued identification, such as a driver's license, military ID, or state-issued ID card. The value is masked in responses unless the caller requests unmasked personally identifiable information (PII). format: text maxLength: 50 |
issuingAuthority | The code/abbreviation of the government authority which issued the identification number, such as "NC" for a driver's license issued in North Carolina. For national issuers (such as passport), this should be the ISO-3611 alpha-2 value for the country.format: text maxLength: 6 |
issuedOn | The date the government or authority issued the identification number. format: date minLength: 10 maxLength: 10 |
expiresOn | The date the government- or authority- issued identification number expires. Normally, the user must submit a non-expired ID number. format: date minLength: 10 maxLength: 10 |
residencyBeganOn | If the identification type is unexpired permanent residency card, this is the date when that residency began. format: date minLength: 10 maxLength: 10 |
birthCountry | If the identification type is unexpired permanent residency card, this is the ISO 3166-1 alpha-2 country code of the applicant's country of birth. The value is masked as ** in responses unless the caller requests unmasked personally identifiable information (PII).minLength: 2 maxLength: 2 pattern: "^[a-zA-Z*]{2}$" |
applicantIdentityHistoryItem
{
"state": "passed",
"createdAt": "2022-11-21T08:43:54.375Z",
"type": "quiz"
}
Applicant Identity Verification Item (v1.0.0)
One verification record for an applicant's history of identity verifications.
Properties
| Name | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Applicant Identity Verification Item (v1.0.0) | One verification record for an applicant's history of identity verifications. | ||||||||||||||||||||
state | The state of the applicant's historical identity verification.
enum values: passed, failed, passedWithRiskFactors, underReview, pending, asked, identityServiceFailure, scoring, expired | ||||||||||||||||||||
type | Describes how the identity verification was performed.
enum values: fraudRiskReport, quiz, adminApproval | ||||||||||||||||||||
createdAt | The date-time when the verification occurred or completed. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.read-only format: date-time minLength: 20 maxLength: 30 | ||||||||||||||||||||
expiredAt | The date-time when the verification expired. This is only set if the state is expired. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.read-only format: date-time minLength: 20 maxLength: 30 |
applicantIdentityVerificationResult
"unknown"
Verification Result (v1.0.0)
The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.
applicantIdentityVerificationResult strings may have one of the following enumerated values:
| Value | Description |
|---|---|
unknown | Unknown: The applicant's identity verification result is unknown. |
verified | Verified: The applicant's identity has been verified (passed). |
unverified | Unverified: The applicant's identity has not been verified (failed). |
type: string
read-only
enum values: unknown, verified, unverified
applicantIdentityVerificationState
"passed"
Applicant Identity Verification state (v1.0.0)
The state of the applicant's historical identity verification.
applicantIdentityVerificationState strings may have one of the following enumerated values:
| Value | Description |
|---|---|
passed | Passed: Identity verification passed. |
failed | Failed: Identity verification failed. |
passedWithRiskFactors | PassedWithRiskFactors: Identity verification passed with risk factors. |
underReview | underReview: Identity verification requires manual review. |
pending | Pending: Identity verification has not started. |
asked | Asked: Identity verification is in progress, after personal questions have been presented to the applicant. |
identityServiceFailure | IdentityServiceFailure: Identity verification failed to complete due to a failure in a back-end or third party service. |
scoring | Scoring: Identity verification is generating a verification score. |
expired | Expired: The applicant did not complete the identity verification process before it expired. |
type: string
enum values: passed, failed, passedWithRiskFactors, underReview, pending, asked, identityServiceFailure, scoring, expired
applicantIdentityVerificationType
"fraudRiskReport"
Applicant Identity Verification Type (v1.0.0)
Describes how the identity verification was performed.
applicantIdentityVerificationType strings may have one of the following enumerated values:
| Value | Description |
|---|---|
fraudRiskReport | Fraud Risk Report: Verification performed by generating a fraud risk report based on the identity's personal information. |
quiz | Quiz: Verification performed by executing a quiz based on personal knowledge the individual should know. |
adminApproval | Admin Approval: Verification performed by an administrator explicitly approving the identity, for example after manually inspecting identity verification documents from the applicant. |
type: string
enum values: fraudRiskReport, quiz, adminApproval
applicantPhoneNumbers
{
"primary": "+19105550155",
"mobile": "+19105550150",
"primaryExtension": "347"
}
Applicant Phone Numbers (v1.0.0)
The applicant's phone numbers.
Properties
| Name | Description |
|---|---|
Applicant Phone Numbers (v1.0.0) | The applicant's phone numbers. |
primary | The primary phone number of the customer. format: phone-number minLength: 5 maxLength: 20 |
secondary | The secondary phone number of the customer. This object is omitted if there is not a secondary phone number. format: phone-number minLength: 5 maxLength: 20 |
mobile | 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 | The alternate phone number of the customer. This object is omitted if there is not an alternate phone number. format: phone-number minLength: 5 maxLength: 20 |
fax | 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 |
primaryExtension | The phone number extension of the primary phone number. minLength: 1 maxLength: 8 pattern: "^[0-9]{1,8}$" |
applicantResidencyStatus
"unknown"
Applicant US Residency Status (v1.0.0)
Describes the type of US residency status if the applicant is not a US citizen.
type: string
enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable
applicantVerification
{
"provider": "IDology",
"sessionId": "c97671fc-b658-4c15-a1c8-819e691b7d3c",
"scoredAt": "2023-01-13T13:28:59.375Z",
"score": "passed",
"result": "verified",
"verifications": [
{
"type": "fraudRiskReport",
"state": "passed",
"createdAt": "2023-01-12T10:15:17Z"
},
{
"type": "quiz",
"state": "passed",
"createdAt": "2023-01-12T10:19:41Z"
}
]
}
Applicant Identity Verification Data (v1.0.0)
Results of identity verification process that tells if an applicant has passed or failed the identity check or if the verification expired.
Properties
| Name | Description |
|---|---|
Applicant Identity Verification Data (v1.0.0) | Results of identity verification process that tells if an applicant has passed or failed the identity check or if the verification expired. |
verifications | array: The history of this contact's identity verifications. read-only maxItems: 32 items: object |
provider | The name of the identity verification provider. read-only format: text maxLength: 32 |
sessionId | The unique ID for the identity verification process. read-only format: text maxLength: 512 |
scoredAt | The date-time when the provider ran identity verification. This is an RFC 3339 time stamp. read-only format: date-time minLength: 20 maxLength: 30 |
score | The indication if the user has passed or failed the identity verification process. enum values: passed, failed, passedWithRiskFactors, underReview, pending, asked, identityServiceFailure, scoring, expired |
result | The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) in the associated user. read-only enum values: unknown, verified, unverified |
applicationAccountReference
{
"id": "98607305d7f7e28424c5",
"name": "My June CD"
}
Application Account Reference (v1.0.0)
A reference to a banking account.
Properties
| Name | Description |
|---|---|
Application Account Reference (v1.0.0) | A reference to a banking account. |
id | The unique ID of the account resource, if known. This is not available until the application has been approved and completed and the account been created in the banking core. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The name (nickname) of new account. If omitted, the account label is derived from from the name of the product and masked account number. format: text maxLength: 128 |
applicationBeneficialOwner
{
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "112-22-3333",
"percentage": 35,
"governmentIssuedId": {
"type": "driversLicense",
"number": "01234567",
"issuingAuthority": "NC",
"issuedOn": "2020-07-10",
"expiresOn": "2026-07-10"
}
}
Application Beneficial Owner (v1.2.0)
A person who owns 25% or more of a business organization.
Properties
| Name | Description |
|---|---|
Application Beneficial Owner (v1.2.0) | A person who owns 25% or more of a business organization. |
prefix | A title or honorific prefix such as Dr. or Fr. format: person-name maxLength: 20 |
firstName | The beneficial owner's first name (or given name). format: text minLength: 0 maxLength: 80 |
middleName | The beneficial owner's middle name. format: text minLength: 1 maxLength: 80 |
lastName | The beneficial owner's last name (or surname). format: text minLength: 1 maxLength: 80 |
suffix | A title or honorific suffix such as PhD or DDS. format: person-name maxLength: 20 |
role | The person's role at the organization. format: text maxLength: 80 |
birthdate | The beneficial owner's birth date in YYYY-MM-DD RFC 3339 date format. The value is masked (some or all digits replaced with an asterisk '*') in responses unless the caller requests unmasked personally identifiable information (PII).format: text minLength: 10 maxLength: 10 pattern: "^[0-9*]{4}-[0-9*]{2}-[0-9*]{2}$" |
taxId | The beneficial owner's US social security number or individual taxpayer ID number (ITIN). The value is masked in responses (showing only one or more asterisks and the last four digits) unless the caller requests unmasked personally identifiable information (PII). format: text minLength: 5 maxLength: 16 |
governmentIssuedId | A secondary form of government issued identification for the beneficial owner. |
percentage | The percent of the business that this person owns. format: float minimum: 0 maximum: 100 |
address | The beneficial owner's primary address. |
emailAddress | The beneficial owner's email address, such as JohnBankCustomer@example.comformat: email minLength: 8 maxLength: 255 |
phoneNumber | The beneficial owner's phone number. format: phone-number minLength: 5 maxLength: 20 |
identityVerificationStatus | The identity verification status for this beneficial owner. This field is read-only and is derived from the results of any Identity API verification applied to this beneficial owner's personally identifiable information (PII). read-only enum values: unknown, verified, unverified |
applicationCustomerType
"personal"
Application Customer Type (v1.0.0)
Indicates the customer type for the account being applied for, either personal (retail) or business (commercial).
type: string
enum values: personal, business
applicationDebitCardRequest
{
"cardholderName": "John Smith",
"requested": true,
"shippingAddress": {
"address1": "P.O. Box 1805",
"locality": "Wilmington",
"regionCode": "NC",
"countryCode": "US",
"postalCode": "28412"
}
}
Application Debit Card Request (v1.0.0)
Describes an optional request for a debit card to be issued for the new account.
Properties
| Name | Description |
|---|---|
Application Debit Card Request (v1.0.0) | Describes an optional request for a debit card to be issued for the new account. |
cardholderName | The name that will appear on the ordered debit card. format: text maxLength: 80 |
requested | Denotes if a debit card was ordered for a given account. |
shippingAddress | The user's shipping address where a debit card is to be sent. |
applicationDocument
{
"type": "governmentId",
"contentType": "application/pdf",
"documentTarget": "personal",
"uri": "https://production.api.apiture.com/vault/7d0e5c70-6efd-4d7e-84c8-d62335227080/content",
"category": "driversLicense"
}
Application Document (v1.1.0)
A document uploaded as part of the application process.
Properties
| Name | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Application Document (v1.1.0) | A document uploaded as part of the application process. | ||||||||||||||||||
type | The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a governmentId etc.).format: text maxLength: 32 | ||||||||||||||||||
contentType | The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8. minLength: 8 maxLength: 191 pattern: "^[-a-z0-9]{4,48}\\/[-+a-z0-9.]{3,142}$" | ||||||||||||||||||
documentTarget | The target of the relevant product, either business or personal.enum values: personal, business | ||||||||||||||||||
category | Document categories for documents uploaded as part of an account application.
enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, articlesOfOrganization | ||||||||||||||||||
uri | The URL of the document applicant had uploaded. format: uri maxLength: 2048 |
applicationMonthlyBankingServiceAmounts
{
"achTransactions": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "oneHundredThousandToOneMillion",
"remoteCheckDeposit": "oneHundredThousandToOneMillion",
"wireTransfers": "oneHundredThousandToOneMillion"
}
Estimated Monthly Banking Service Amounts (v1.0.0)
Estimated monthly amounts for banking services.
Properties
| Name | Description |
|---|---|
Estimated Monthly Banking Service Amounts (v1.0.0) | Estimated monthly amounts for banking services. |
achTransactions | The estimated total amount sent or received by ACH per month. Use this or sentAch/receivedAch. This value is the name of a range as defined by the financial institution.format: text maxLength: 40 |
mobileCheckDeposit | The estimated amount deposited by mobile app per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
remoteCheckDeposit | The estimated amount deposited remotely, via scanned images, per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
wireTransfers | The estimated wire transfer amount sent or received per month. Use this or sentWire/receivedWire. This value is the name of a range as defined by the financial institution.format: text maxLength: 40 |
applicationMonthlyBankingServiceCounts
{
"achTransactions": "oneHundredOneToOneThousand",
"mobileCheckDeposit": "oneHundredOneToOneThousand",
"remoteCheckDeposit": "oneHundredOneToOneThousand",
"wireTransfers": "oneToOneHundred"
}
Estimated Monthly Banking Service Counts (v1.0.0)
Estimated monthly activity for banking services.
Properties
| Name | Description |
|---|---|
Estimated Monthly Banking Service Counts (v1.0.0) | Estimated monthly activity for banking services. |
achTransactions | The estimated total number of ACH transactions per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
mobileCheckDeposit | The estimated number of mobile app deposits per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
remoteCheckDeposit | The estimated number of remote deposits (via scanned images) per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
wireTransfers | The estimated number of wire transfers sent or received per month. This value is the name of a range as defined by the financial institution. format: text maxLength: 40 |
applicationOpenedAccount
{
"maskedNumber": "*6789",
"accountNumber": "123456789"
}
Application Opened Account (v1.0.0)
The new banking account opened via this application.
Properties
| Name | Description |
|---|---|
Application Opened Account (v1.0.0) | The new banking account opened via this application. |
accountNumber | A full account number. This is the number that the customer uses to reference the account within the financial institution. This property is present only if the caller requests unmasked data. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$" |
maskedNumber | A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$" |
applicationOrganization
{
"id": "638ae35cbe5b7e0baa40",
"legalName": "Max Peck Towing, LLC",
"doingBusinessAs": "Max Peck Towing",
"taxId": "112-22-3333",
"yearsOwned": "fourOrMoreYears",
"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"
}
},
"emailAddress": "Max.Pike@example.com",
"phoneNumbers": {
"primary": "+19105550155",
"primaryPhoneNumberExtension": "347"
},
"home_url": "http://max-peck-towing.example.com"
},
"approvals": [
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "rejected",
"done": true,
"reason": "Invalid U.S. Address",
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
],
"industrySector": "otherServices",
"countryOfOperations": "US",
"registeredIn": "NC",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"estimatedAnnualRevenue": "under1Million",
"regulatory": {
"atmOperator": false,
"charity": false,
"internetGambling": false,
"marijuanaBusiness": false,
"intermediaryServices": [],
"subjectToWithholdings": false
},
"physicalLocationsCount": "from10to50",
"legalStructure": "soleProprietorship",
"estimatedMonthlyAmounts": {
"achTransactions": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "oneHundredThousandToOneMillion",
"remoteCheckDeposit": "oneHundredThousandToOneMillion",
"wireTransfers": "oneHundredThousandToOneMillion"
},
"estimatedMonthlyCounts": {
"achTransactions": "oneHundredOneToOneThousand",
"mobileCheckDeposit": "oneHundredOneToOneThousand",
"remoteCheckDeposit": "oneHundredOneToOneThousand",
"wireTransfers": "oneToOneHundred"
},
"beneficialOwners": [
{
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "112-22-3333",
"percentage": 35,
"governmentIssuedId": {
"type": "driverLicense",
"number": "01234567",
"issuingAuthority": "NC",
"issuedOn": "2020-07-10",
"expiresOn": "2026-07-10"
}
}
],
"updatedAt": "2023-10-24T06:26:53.375Z"
}
Application Organization (v1.2.0)
The business associated with a new business account application.
Properties
| Name | Description |
|---|---|
Application Organization (v1.2.0) | The business associated with a new business account application. |
id | The unique ID of this organization resource. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
legalName | The company legal name. format: text maxLength: 80 |
doingBusinessAs | The company "doing business as" name. format: text maxLength: 80 |
taxId | The tax identification number or Employer Identification Number (EIN) of the organization. format: text minLength: 4 maxLength: 32 |
contactCard | An organization's contact information. |
industrySector | The industry sector of this organization. This is an identifier, such as financialServices, professionalServices, education, realEstate, vehicleSales, or other. The sector names are defined by the financial institution.minLength: 2 maxLength: 40 pattern: "^[a-z][a-zA-Z0-9]{1,39}$" |
countryOfOperations | The ISO 3166-1 alpha-2 country code for the organization's operation. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
registeredIn | The US state or other region in which the organization is registered. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
employeeCountLowerBound | The lower bound of the numeric range of persons employed by the organization. format: int32 minimum: 1 maximum: 20000000 |
employeeCountUpperBound | The upper bound of the numeric range of persons employed by the organization. format: int32 minimum: 1 maximum: 20000000 |
physicalLocationsCount | The number of physical sites, offices, or locations the organization owns, operates, or occupies. This is an identifier which defines a range of values, such as from10to50 or moreThan100, as set by the financial institution.minLength: 2 maxLength: 40 pattern: "^[a-z][a-zA-Z0-9]{1,39}$" |
legalStructure | The type of business or organization associated with the new account application. This is an identifier, such as soleProprietorship, financialInstitution, corporation, unknown, or other`. The names are defined by the financial institution.minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9]{1,63}$" |
approvals | array: Any approvals associated with this business. maxItems: 50 items: object |
regulatory | Responses to regulatory-related questions about the business associated with a new account application. |
estimatedMonthlyAmounts | Estimated monthly amounts for banking services. |
estimatedMonthlyCounts | Estimated banking activity per month. |
estimatedAnnualRevenue | The range of estimated revenue in US dollars. This value is the name of a range, such as from10to100Million; these identifiers are defined by the financial institution.enum values: unknown, under1Million, from1to10Million, from10to100Million, over100Million, other, notApplicable |
beneficialOwners | array: A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future. maxItems: 10 items: object |
yearsOwned | The range of years the owners/operators have owned the business. enum values: unknown, one, two, three, fourOrMoreYears, other, notApplicable |
updatedAt | The date-time when the organization was updated read-only format: date-time minLength: 20 maxLength: 30 |
applicationOrganizationEstimatedAnnualRevenue
"unknown"
Estimated Annual Revenue (v1.0.0)
The estimated annual revenue in US dollars.
type: string
enum values: unknown, under1Million, from1to10Million, from10to100Million, over100Million, other, notApplicable
applicationOrganizationReference
{
"id": "string",
"legalName": "string",
"doingBusinessAs": "string",
"taxId": "string"
}
Application Organization Reference (v1.0.0)
A reference to an application organization.
Properties
| Name | Description |
|---|---|
Application Organization Reference (v1.0.0) | A reference to an application organization. |
id | The unique ID of this organization resource. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
legalName | The company legal name. format: text maxLength: 80 |
doingBusinessAs | The company "doing business as" name. format: text maxLength: 80 |
taxId | The company tax identification number or Employer Identification Number (EIN). format: text maxLength: 32 |
applicationProductReference
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
Application Product Reference (v1.0.0)
A reference to a banking product.
Properties
| Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Application Product Reference (v1.0.0) | A reference to a banking product. | ||||||||
type | The type of account. enum values: savings, checking, cd, ira, loan, creditCard | ||||||||
target | Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).
enum values: personal, business, both | ||||||||
code | The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same type and the same coreType but different rates or other properties have different product codes, such as CD3M, DDA_HI_YLD, P3207.format: text minLength: 1 maxLength: 16 | ||||||||
label | The human-readable label or name of this banking product. format: text minLength: 2 maxLength: 48 |
applicationReviewerReference
{
"id": "ffc90da873-92147f6832",
"firstName": "Sven",
"lastName": "Labrador"
}
Application Reviewer Reference (v1.0.0)
Describes a financial institution operator or staff member (or system) which reviewed an account application.
Properties
| Name | Description |
|---|---|
Application Reviewer Reference (v1.0.0) | Describes a financial institution operator or staff member (or system) which reviewed an account application. |
id | The id of the operator that reviewed the approval. This is the string <system> if the application was automatically approved or rejected without operator intervention.read-only format: text maxLength: 48 |
firstName | The first name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by id. This is the string <system> if the application was automatically approved or rejected without operator intervention.format: text minLength: 1 maxLength: 80 |
lastName | The last name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by id. This is the string <system> if the application was automatically approved or rejected without operator intervention.format: text minLength: 1 maxLength: 80 |
applicationState
"approved"
Application State (v1.0.0)
The state of the enrollment or application.
applicationState strings may have one of the following enumerated values:
| Value | Description |
|---|---|
pending | Pending: Available to be started. This state is reserved for future use. |
running | Running: Started and has not completed or been canceled. |
blocked | Blocked: Started but is blocked; there are no available workflow tasks. |
canceled | Canceled: Canceled prior to completion. |
expired | Expired: Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired. |
rejected | Rejected: Completed but was rejected after review. |
approved | Approved: Completed and approved. |
type: string
enum values: pending, running, blocked, canceled, expired, rejected, approved
applicationType
"newAccount"
Application Type (v1.0.0)
The type of an application.
applicationType strings may have one of the following enumerated values:
| Value | Description |
|---|---|
newAccount | New Account: An application for a new banking account |
jointOwner | Joint Owner: An application to accept a joint owner invitation to an existing account |
type: string
enum values: newAccount, jointOwner
approval
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "rejected",
"done": true,
"reason": "Invalid U.S. Address",
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
Approval (v1.0.0)
An approval represents the review of some process, activity or resource, such as a document or an application. The state of the approval is recorded in its state property. The URL of the target of the approval is in the target_url.
Properties
| Name | Description |
|---|---|
Approval (v1.0.0) | An approval represents the review of some process, activity or resource, such as a document or an application. The state of the approval is recorded in its state property. The URL of the target of the approval is in the target_url. |
id | The unique identifier for this approval resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
state | The state of this approval. This property is derived and immutable. read-only default: "open" enum values: open, submitted, approved, rejected, waived, returned, canceled |
target_url | The URL of the resource that this approval applies to, such as a document an applicant has uploaded as part of an application. format: url maxLength: 2048 |
done | If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable.read-only |
reviewedBy | The unique operator ID of the operator that reviewed the approval. This is an operator resource ID, not the operator's login ID. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
reason | The reason given for the last state change, such as why the approval was approved, rejected, waived, canceled, or returned. format: text maxLength: 512 |
createdAt | The approval's creation date-time, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.read-only format: date-time minLength: 20 maxLength: 30 |
updatedAt | The date-time of the approval's most recent update, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.read-only format: date-time minLength: 20 maxLength: 30 |
reviewedAt | The date-time when the approval was reviewed. read-only format: date-time minLength: 20 maxLength: 30 |
approvalType | The type of this approval. |
approvalState
"open"
Approval State (v1.0.0)
The state of this approval.
approvalState strings may have one of the following enumerated values:
| Value | Description |
|---|---|
open | Open: An approval that has been created but not submitted for review. |
submitted | Submitted: An approval that has been submitted for review but not yet reviewed. |
approved | Approved: An approval which has been approved by the financial institution. |
rejected | Rejected: An approval which has been rejected by the financial institution. |
waived | Waived: An approval which has been waived by the financial institution. |
returned | Returned: An approval which has been returned by the financial institution. The user should update the data that is the target of the review. |
canceled | Canceled: An approval which has been canceled by the user or the financial institution. |
type: string
default: "open"
enum values: open, submitted, approved, rejected, waived, returned, canceled
approvalTypeItem
{
"id": "a37edb797f43d74a5a73",
"name": "governmentId",
"label": "Government Issued ID"
}
Approval Type Item (v1.0.0)
Approval Type Item.
Properties
| Name | Description |
|---|---|
Approval Type Item (v1.0.0) | Approval Type Item. |
id | The unique identifier for this approval type resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The approval type's name. This is an identifier, such as governmentIdformat: text maxLength: 64 |
label | The approval type's common (human-readable) label. format: text maxLength: 128 |
beneficialOwnerGovernmentIssuedId
{
"type": "driversLicense",
"number": "01234567",
"issuingAuthority": "NC",
"issuedOn": "2020-07-10",
"expiresOn": "2026-07-10"
}
Beneficial Owner Government-Issued Identification (v1.0.0)
Describes a secondary form of government-issued identification for a beneficial owner.
Properties
| Name | Description |
|---|---|
Beneficial Owner Government-Issued Identification (v1.0.0) | Describes a secondary form of government-issued identification for a beneficial owner. |
type | Indicates what type of state, government, or other authority issued identification used for a person's identification. This is a programmatic identifier, such as driversLicense, stateId, passport or militaryId, not a label.format: text maxLength: 32 |
number | The ID number on the government- or authority- issued identification, such as a driver's license, military ID, or state-issued ID card. The value is masked in responses unless the caller requests unmasked personally identifiable information (PII). format: text maxLength: 50 |
issuingAuthority | The code/abbreviation of the government authority which issued the identification number, such as "NC" for a driver's license issued in North Carolina. For national issuers (such as passport), this should be the ISO-3611 alpha-2 value for the country.format: text maxLength: 6 |
issuedOn | The date the government or authority issued the identification number. format: date minLength: 10 maxLength: 10 |
expiresOn | The date the government- or authority- issued identification number expires. Normally, the user must submit a non-expired ID number. format: date minLength: 10 maxLength: 10 |
challengeFactor
{
"type": "sms",
"labels": [
"9876"
]
}
Challenge Factor (v1.2.1)
An challenge factor. See requiredIdentityChallenge for multiple examples.
Properties
| Name | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Challenge Factor (v1.2.1) | An challenge factor. See requiredIdentityChallenge for multiple examples. | ||||||||||||
id | The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The | ||||||||||||
type | The name of challenge factor.
enum values: sms, email, voice, securityQuestions, authenticatorToken | ||||||||||||
labels | array: [ A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.minItems: 1 maxItems: 4 items: string(text)» format: text » maxLength: 300 | ||||||||||||
securityQuestions | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions. |
challengeFactorId
"string"
Challenge Factor ID (v1.0.0)
The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
type: string
minLength: 3 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{3,48}$"
challengeFactorType
"sms"
Challenge Factor Type (v1.0.0)
The name of challenge factor.
challengeFactorType strings may have one of the following enumerated values:
| 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
challengeOperationId
"string"
Challenge Operation ID (v1.0.1)
The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
type: string
minLength: 6 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{6,48}$"
challengePromptId
"string"
Challenge Prompt ID (v1.0.0)
The unique ID of a prompt (such as a security question) in a challenge factor.
type: string
minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]+$"
challengeSecurityQuestion
{
"id": "74699fa628911e762ea5",
"prompt": "What is your mother's maiden name?"
}
Challenge Security Question (v1.0.1)
A single security question within the questions array of the challengeSecurityQuestions
Properties
| Name | Description |
|---|---|
Challenge Security Question (v1.0.1) | A single security question within the questions array of the challengeSecurityQuestions |
id | The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId.minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]+$" |
prompt | The text prompt of this security question. format: text maxLength: 80 |
challengeSecurityQuestions
{
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
}
Challenge Security Questions (v1.0.1)
Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
Properties
| Name | Description |
|---|---|
Challenge Security Questions (v1.0.1) | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions. |
questions | array: (required) The array of security questions. minItems: 1 maxItems: 8 items: object |
contentType
"application/pdf"
- (v1.0.0)*
The media type of a file.
type: string
minLength: 8 maxLength: 191 pattern: "^[-a-z0-9]{4,48}\/[-+a-z0-9.]{3,142}$"
currencyCode
"str"
- (v1.0.0)*
A ISO 4217 currency code This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.
type: string(text)
format: text minLength: 3 maxLength: 3 pattern: "^[A-Z]{3}$"
customerAccountApplicant
{
"id": "6fed31a71850ae9b287d",
"firstName": "Elsa",
"lastName": "Snowqueen",
"username": "elsa_332",
"attested": true,
"role": {
"name": "Primary Account Holder"
},
"verification": {
"provider": "IDology",
"sessionId": "c97671fc-b658-4c15-a1c8-819e691b7d3c",
"scoredAt": "2023-01-13T13:28:59.375Z",
"score": "passed",
"result": "verified",
"verifications": [
{
"type": "fraudRiskReport",
"state": "passed",
"createdAt": "2023-01-12T10:15:17Z"
},
{
"type": "quiz",
"state": "passed",
"createdAt": "2023-01-12T10:19:41Z"
}
]
},
"contactCard": {
"phoneNumbers": {
"primary": "+19105551234",
"primaryExtension": "337"
},
"emailAddress": "elsa.snowqueen@example.com",
"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"
},
"yearsAtPrimaryAddress": "fourOrMore"
}
},
"birthdate": "1995-01-30",
"dueDiligenceAnswers": {
"bankingPurpose": "operational funds",
"citizen": true,
"foreignPoliticalFigure": false,
"familyOfPoliticalFigure": false,
"w9Withholdings": false,
"primaryIncomeSource": "wages",
"internationalTransfers": false,
"identification": {
"type": "driversLicense",
"number": "****1234",
"issuingAuthority": "NC",
"issuedOn": "2018-01-30",
"expiresOn": "2026-01-29"
},
"employment": {
"status": "fullTime",
"currentEmployerName": "Max Peck Towing",
"occupation": "accountant",
"currentJobTitle": "Chief Accountant"
}
}
}
Account Applicant (v1.0.0)
An applicant for a new account.
Properties
| Name | Description |
|---|---|
Account Applicant (v1.0.0) | An applicant for a new account. |
id | The ADB customer ID of the applicant. read-only format: text maxLength: 48 |
firstName | The first name of the applicant. format: text minLength: 1 maxLength: 128 |
lastName | The last name of the applicant. format: text minLength: 1 maxLength: 128 |
username | The unique login username for the applicant. If omitted on a request, this field will be set for the primary applicant, based on the username of the authenticated applicant that creates the application. For co-owners and beneficial-owners this field is optional. format: text maxLength: 20 |
contactCard | The contact information for the customer. Email addresses and phone numbers are masked unless the request uses ?unmasked=true. |
birthdate | The applicant's birth date in YYYY-MM-DD RFC 3339 date format.format: date |
taxId | The applicant's US social security number or individual taxpayer ID number (ITIN). The value is masked in responses (showing only one or more asterisks and the last four digits) unless the caller requests unmasked personally identifiable information (PII). format: text minLength: 5 maxLength: 16 |
dueDiligenceAnswers | Answers the applicant provided for "Know Your Customer" due diligence questions which allow financial institutions to conform to their Customer Identification Program. Some financial institutions may choose to not collect all of these answers. |
attested | If true, the applicant attested the information provided is true and accurate |
role | The role the applicant has relative to the account. |
verification | The verification status of the primary applicant. |
customerAccountApplication
{
"type": "newAccount",
"state": "blocked",
"products": [
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
],
"flaggedForReview": true,
"hasUnresolvedProblems": true,
"reviewer": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"id": "0399abed-fd3d",
"applicant": {
"id": "6fed31a71850ae9b287d",
"username": "elsa_332",
"firstName": "Elsa",
"lastName": "Snowqueen",
"birthdate": "1995-01-30",
"role": {
"name": "Primary Account Holder"
},
"verification": {
"provider": "IDology",
"sessionId": "c97671fc-b658-4c15-a1c8-819e691b7d3c",
"scoredAt": "2023-01-13T13:28:59.375Z",
"score": "passed",
"result": "verified",
"verifications": [
{
"type": "fraudRiskReport",
"state": "passed",
"createdAt": "2023-01-12T10:15:17Z"
},
{
"type": "quiz",
"state": "passed",
"createdAt": "2023-01-12T10:19:41Z"
}
]
},
"attested": true,
"contactCard": {
"phoneNumbers": {
"primary": "+19105551234",
"primaryExtension": "337"
},
"emailAddress": "elsa.snowqueen@example.com",
"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"
},
"yearsAtPrimaryAddress": "fourOrMore"
}
},
"dueDiligenceAnswers": {
"bankingPurpose": "operational funds",
"citizen": true,
"foreignPoliticalFigure": false,
"familyOfPoliticalFigure": false,
"w9Withholdings": false,
"primaryIncomeSource": "wages",
"internationalTransfers": false,
"identification": {
"type": "driversLicense",
"number": "****1234",
"issuingAuthority": "NC",
"issuedOn": "2018-01-30",
"expiresOn": "2026-01-29"
},
"employment": {
"status": "fullTime",
"currentEmployerName": "Max Peck Towing",
"occupation": "accountant",
"currentJobTitle": "Chief Accountant"
}
}
},
"organization": {
"id": "638ae35cbe5b7e0baa40",
"legalName": "Max Peck Towing, LLC",
"doingBusinessAs": "Max Peck Towing",
"taxId": "112-22-3333",
"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"
}
},
"emailAddress": "Max.Pike@example.com",
"phoneNumbers": {
"primary": "+19105550155"
},
"home_url": "http://max-peck-towing.example.com"
},
"approvals": [
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "rejected",
"done": true,
"reason": "Invalid U.S. Address",
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
],
"industrySector": "otherServices",
"countryOfOperations": "US",
"registeredIn": "NC",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"estimatedAnnualRevenue": "under1Million",
"regulatory": {
"atmOperator": false,
"charity": false,
"internetGambling": false,
"marijuanaBusiness": false,
"subjectToWithholdings": false,
"intermediaryServices": []
},
"physicalLocationsCount": "from10to50",
"legalStructure": "soleProprietorship",
"estimatedMonthlyAmounts": {
"achTransactions": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "oneHundredThousandToOneMillion",
"remoteCheckDeposit": "oneHundredThousandToOneMillion",
"wireTransfers": "oneHundredThousandToOneMillion"
},
"estimatedMonthlyCounts": {
"achTransactions": "oneHundredOneToOneThousand",
"mobileCheckDeposit": "oneHundredOneToOneThousand",
"remoteCheckDeposit": "oneHundredOneToOneThousand",
"wireTransfers": "oneToOneHundred"
},
"beneficialOwners": [
{
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "112-22-3333",
"percentage": 35
}
],
"updatedAt": "2023-10-24T06:26:53.375Z"
},
"approvals": [
{
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "approved",
"done": true,
"createdAt": "2023-10-10T07:57:04.375Z",
"updatedAt": "2023-10-11T07:57:08.375Z",
"reviewedAt": "2023-10-12T07:57:13.375Z",
"target_url": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe/content",
"approvalType": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "governmentId",
"label": "Government Issued ID"
}
}
],
"assignee": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"documents": [
{
"type": "governmentId",
"contentType": "application/pdf",
"documentTarget": "business",
"category": "driversLicense",
"uri": "https://production.api.apiture.com/vault/7d0e5c70-6efd-4d7e-84c8-d62335227080/content"
},
{
"type": "articlesOfOrganization",
"contentType": "application/pdf",
"documentTarget": "business",
"category": "articlesOfOrganization",
"uri": "https://production.api.apiture.com/vault/642c977e-4f24-4d7e-bccc-7e275fbfc415/content"
}
],
"funding": {
"maskedNumber": "*1234",
"routingNumber": "123123123",
"institutionName": "Third Party Bank",
"location": "external",
"type": "checking",
"verificationMethod": "instant",
"fundingAmount": {
"value": "1000.00",
"currency": "USD"
},
"authorization": {
"granted": true,
"grantedAt": "2024-02-01T05:58:21.375Z",
"message": "I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789."
}
},
"debitCardRequest": {
"cardholderName": "John Smith",
"requested": true,
"shippingAddress": {
"address1": "P.O. Box 1805",
"locality": "Wilmington",
"regionCode": "NC",
"countryCode": "US",
"postalCode": "28412"
}
},
"account": {
"maskedNumber": "*6789",
"accountNumber": "123456789"
},
"createdAt": "2023-10-15T06:16:36.375Z",
"submittedAt": "2023-10-16T16:42:50.375Z",
"reviewedAt": "2023-10-17T06:22:27.375Z",
"trackingIds": [
{
"id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
"createdAt": "2021-06-07T09:11:02.375Z"
}
],
"notes": [
{
"id": "0399abed-fd3d",
"text": "Please review this fraud report.",
"createdAt": "2023-04-19T10:49:28.375Z",
"creator": {
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings",
"state": "active"
},
"attachments": [
{
"id": "0399abed-fd3d",
"name": "fraud-report-389398.pdf",
"contentType": "application/pdf",
"url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
"contentLength": 276000
}
]
}
]
}
Customer Account Application (v1.1.0)
Representation of a customer account application resource.
Properties
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
Customer Account Application (v1.1.0) | Representation of a customer account application resource. | ||||||
type | The type of an application.
enum values: newAccount, jointOwner | ||||||
state | The state of the application. The value is updated by the various application action operations. read-only enum values: pending, running, blocked, canceled, expired, rejected, approved | ||||||
products | array: The list of banking products to be opened by this application. Present only if type is newAccount.minItems: 1 maxItems: 8 items: object | ||||||
account | The account to be opened. | ||||||
flaggedForReview | true if the application is blocked awaiting review from the financial institution. This is derived from the state and approvals of the application, and is immutable.read-only | ||||||
hasUnresolvedProblems | true if the application has at least one unresolved problem. This is derived from the list of problems tied to the application and is immutable. | ||||||
reviewer | The most recent operator assigned to review this application. This field is omitted if no reviewed is assigned. | ||||||
requiredDocuments | array: An array of metadata describing one or more required documents which the applicant may need to provide during the application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts), etc. maxItems: 16 items: object | ||||||
documents | array: An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts), etc. The items in this array match with the requiredDocuments 1-to-1 and items may be null if the user has not yet uploaded the corresponding required document.maxItems: 16 items: object | ||||||
assignee | Describes a financial institution operator or staff member that this application is assigned to. This property is omitted if the application is not assigned an operator. | ||||||
id | The unique identifier for this customer account application resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" | ||||||
applicant | The primary account applicant. | ||||||
organization | The business or organization that is the owner of the account. This is only present if corresponding banking product type is business. | ||||||
approvals | array: Any approvals associated with this application. maxItems: 50 items: object | ||||||
funding | Describes how the new account is funded. | ||||||
debitCardRequest | Describes an optional request for a debit card to be issued for the new account. | ||||||
reviewedAt | The date-time when the application was last reviewed. This property is omitted if the financial institution has not yet manually reviewed this application. read-only format: date-time minLength: 20 maxLength: 30 | ||||||
notes | array: Any notes that operators/reviewers have attached to this application. maxItems: 10000 items: object | ||||||
createdAt | The date-time when the approval was created. read-only format: date-time minLength: 20 maxLength: 30 | ||||||
updatedAt | The date-time when the application was last modified. This property is omitted if the application has not been modified since it was created. read-only format: date-time minLength: 20 maxLength: 30 | ||||||
submittedAt | The date-time when the application was submitted. This property is omitted if the application has not been submitted. read-only format: date-time minLength: 20 maxLength: 30 | ||||||
completedAt | The date-time when the application was completed. This property is omitted if the application has not been approved, rejected, canceled, or expired. read-only format: date-time minLength: 20 maxLength: 30 | ||||||
trackingIds | array: An array of tracking IDs associated with the application. maxItems: 150 items: object |
customerAccountApplicationItem
{
"type": "newAccount",
"state": "blocked",
"products": [
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
],
"flaggedForReview": true,
"hasUnresolvedProblems": true,
"reviewer": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"id": "0399abed-fd3d",
"applicant": {
"id": "6fed31a71850ae9b287d",
"username": "elsa_332",
"firstName": "Elsa",
"lastName": "Snowqueen"
},
"approvals": [],
"assignee": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
}
}
Customer Account Application Item (v1.2.0)
Summary representation of a customer account application resource in customer account applications collections. To fetch the full representation of this customer account application, use the getCustomerAccountApplication operation, passing this item's id field as the accountApplicationId path parameter.
Properties
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
Customer Account Application Item (v1.2.0) | Summary representation of a customer account application resource in customer account applications collections. To fetch the full representation of this customer account application, use the getCustomerAccountApplication operation, passing this item's id field as the accountApplicationId path parameter. | ||||||
type | The type of an application.
enum values: newAccount, jointOwner | ||||||
state | The state of the application. The value is updated by the various application action operations. read-only enum values: pending, running, blocked, canceled, expired, rejected, approved | ||||||
products | array: The list of banking products to be opened by this application. Present only if type is newAccount.minItems: 1 maxItems: 8 items: object | ||||||
account | A reference to a banking account. | ||||||
flaggedForReview | true if the application is blocked awaiting review from the financial institution. This is derived from the state and approvals of the application, and is immutable.read-only | ||||||
hasUnresolvedProblems | true if the application has at least one unresolved problem. This is derived from the list of problems tied to the application and is immutable. | ||||||
reviewer | The most recent operator assigned to review this application. This field is omitted if no reviewed is assigned. | ||||||
assignee | Describes a financial institution operator or staff member that this application is assigned to. This property is omitted if the application is not assigned an operator. | ||||||
id | The unique identifier for this customer account application resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" | ||||||
applicant | The primary account applicant. | ||||||
organization | The business or organization that is the owner of the account. This is only present if corresponding banking product type is business. | ||||||
approvals | array: (required) Any approvals associated with this application. maxItems: 50 items: object |
customerAccountApplications
{
"start": "d1b48af913464aa49fcb07065dcc0616",
"limit": 10,
"nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAccountApplications?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
"items": [
{
"id": "0399abed-fd3d",
"type": "newAccount",
"state": "blocked",
"products": [
{
"type": "cd",
"target": "business",
"code": "180D_CDA",
"label": "180-Day High Yield CD"
}
],
"flaggedForReview": true,
"hasUnresolvedProblems": true,
"applicant": {
"id": "97fd7e918b7ae6588b4b",
"firstName": "Elsa",
"lastName": "Snowqueen"
},
"organization": {
"id": "21ae7ee4af1e786f2be4",
"legalName": "Max Peck Mobile Repair"
},
"account": {
"name": "My June CD"
},
"approvals": [],
"reviewer": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
},
"assignee": {
"id": "ffc90da87392147f6832",
"firstName": "Sven",
"lastName": "Labrador"
}
}
]
}
Customer Account Application Collection (v1.2.0)
Collection of customer account applications. The items in the collection are ordered in the items array. The response object may contain the nextPage_url pagination link..
Properties
| Name | Description |
|---|---|
Customer Account Application Collection (v1.2.0) | Collection of customer account applications. The items in the collection are ordered in the items array. The response object may contain the nextPage_url pagination link.. |
limit | The number of items requested for this page response. The length of the items array may be less that limit.format: int32 minimum: 0 maximum: 10000 |
nextPage_url | The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection. read-only format: uri-reference maxLength: 8000 |
start | The opaque cursor that specifies the starting location of this page of items. format: text maxLength: 256 |
items | array: (required) An array containing a page of customer account application items. maxItems: 10000 items: object |
customerEmailAddress
"Max.Pike@example.com"
Customer Email Address (v1.0.0)
A customer's single email address.
type: string(email)
format: email maxLength: 255
customerPhoneNumbers
{
"primary": "+19105550155",
"mobile": "+19105550150"
}
Customer Phone Numbers (v1.0.0)
A customer's phone numbers.
Properties
| Name | Description |
|---|---|
Customer Phone Numbers (v1.0.0) | A customer's phone numbers. |
primary | The primary phone number of the customer. format: phone-number minLength: 5 maxLength: 20 |
secondary | The secondary phone number of the customer. This object is omitted if there is not a secondary phone number. format: phone-number minLength: 5 maxLength: 20 |
mobile | 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 | The alternate phone number of the customer. This object is omitted if there is not an alternate phone number. format: phone-number minLength: 5 maxLength: 20 |
fax | 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 |
customerRole
{
"name": "string"
}
Customer Role (v1.0.0)
Customer Role.
Properties
| Name | Description |
|---|---|
Customer Role (v1.0.0) | Customer Role. |
name | The name (identifier) of the role, such as primaryAccountHolder.format: text maxLength: 48 |
customerUsername
"string"
Customer Username (v1.0.0)
A customer's login username.
type: string(text)
format: text maxLength: 20
date
"2021-10-30"
Date (v1.0.0)
A date formatted in YYYY-MM-DD RFC 3339 date UTC format.
type: string(date)
format: date minLength: 10 maxLength: 10
dateTimeRange
"[2023-04-28T00:00:00Z,]"
Date Time Range (v1.0.0)
A query parameter for selecting items in a date-time range. Filter the response to only items that fall in the range bounded by start and end date-times. The start and end values are either dates in RFC 3339 YYYY-MM-DD date format, or date-times in YYYY-MM-DDThh:mm:ss.sssZ date-time format.
For example
[start,end]between start and end date/times, inclusive of the endpoints(start,end)between start and end date/times, exclusive of the endpoints(start,end]between start and end date/times, exclusive of start and inclusive of the end[start,end)between start and end date/times, inclusive of start and exclusive of the endYYYY-MM-DDequivalent to[YYYY-MM-DD,YYYY-MM-DD]
Dates without a time component are converted to UTC date-time values. If start or end are date values, then start00 is defined as time 00:00:00Z on the start date, start24 is defined as 00:00AM of the day after the start date: end00 is defined as time 00:00:00Z on the end date, end24 is defined as 00:00AM of the day after the end date:
[start,end]is the same as[start00,end24)(start,end]is the same as(start24,end24)[start,end)is the same as[start00,end00)(start,end)is the same as(start24,end00)
For example, the range [2023-05-01,2023-06-01) matches any day/time in May 2023 and is equivalent to [2023-05-01T00:00:00.00Z,2023-06-01T00:00:00.00Z).
type: string(text)
format: text minLength: 10 maxLength: 63 pattern: "^((\d{4}-\d{2}-\d{2})|([[(](((\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?),(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)?)|(,(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)))[)\]]))$"
foreignPoliticalFigureAssociation
"unknown"
Foreign Political Figure Association (v1.0.0)
The type of association to a foreign political figure.
foreignPoliticalFigureAssociation strings may have one of the following enumerated values:
| Value | Description |
|---|---|
unknown | Unknown: The association status of this individual is unknown. |
closeAssociate | Close Associate: This individual is a close associate of a foreign political figure. |
familyMember | Family Member: This individual is a family member of a foreign political figure. |
none | None: This individual has no association to a foreign political figure. |
other | Other |
notApplicable | Not Applicable |
type: string
enum values: unknown, closeAssociate, familyMember, none, other, notApplicable
fullAccountNumber
"123456789"
Full Account Number (v1.0.0)
A full account number. This is the number that the customer uses to reference the account within the financial institution.
type: string
minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"
fundingAccountVerificationMethod
"instant"
Account Verification Method (v1.0.0)
Indicates how an external account was verified: micro deposits or IAV (Instant Account Verification).
type: string
enum values: instant, microDeposit
lowerCamelCaseIdentifier40
"accountId"
Lower Camel Case Identifier (v1.0.0)
A Lower Camel Case Identifier string, up to 40 characters long.
type: string
minLength: 2 maxLength: 40 pattern: "^[a-z][a-zA-Z0-9]{1,39}$"
lowerCamelCaseIdentifier64
"accountId"
Lower Camel Case Identifier (v1.0.0)
A Lower Camel Case Identifier string, up to 64 characters long.
type: string
minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9]{1,63}$"
maskedAccountNumber
"*1008"
Masked Account Number (v1.0.1)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
type: string
minLength: 2 maxLength: 5 pattern: "^\*[- _a-zA-Z0-9.]{1,4}$"
monetaryValue
"3456.78"
Monetary Value (v1.1.0)
The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.
type: string
maxLength: 16 pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"
money
{
"value": "1000.00",
"currency": "USD"
}
Money (v1.0.0)
An amount of money in a specific currency.
Properties
| Name | Description |
|---|---|
Money (v1.0.0) | An amount of money in a specific currency. |
value | The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision. maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$" |
currency | The ISO 4217 currency code for this monetary value. format: text minLength: 3 maxLength: 3 pattern: "^[A-Z]{3}$" |
nonCitizenApplicant
{
"countryCode": "GB",
"type": "citizen"
}
Non-Citizen Applicant (v1.0.0)
Information about US residency and nationality of citizenship for applicants who are not US citizens.
Properties
| Name | Description |
|---|---|
Non-Citizen Applicant (v1.0.0) | Information about US residency and nationality of citizenship for applicants who are not US citizens. |
countryCode | The ISO 3166-1 country code for the individual's citizenship or resident nationality. This is normalized to uppercase. The value is masked as ** in responses unless the caller requests unmasked personally identifiable information (PII).minLength: 2 maxLength: 2 pattern: "^[a-zA-Z*]{2}$" |
type | The individual's citizenship status in the non-US country. enum values: citizen, other |
usResidencyStatus | Describes the type of US residency status if the applicant is not a US citizen. enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable |
organizationAddresses
{
"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"
}
}
Organization Addresses (v1.0.0)
An applicant's postal addresses.
Properties
| Name | Description |
|---|---|
Organization Addresses (v1.0.0) | An applicant's postal addresses. |
primary | The organization's primary address. For individuals, this is their home address. For businesses, this is the company's business address. |
mailing | The organization's mailing address. If present, financial institution sends statements and other documents to this address instead of the primary address. |
previous | The organization's previous address. |
organizationContactCard
{
"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"
}
},
"emailAddress": "Max.Peck@example.com",
"phoneNumbers": {
"primary": "+19105550155",
"primaryPhoneNumberExtension": "347"
},
"home_url": "http://max-peck-mobile-service.example.com"
}
Customer Application Organization Contact Card (v1.0.0)
An organization's contact information.
Properties
| Name | Description |
|---|---|
Customer Application Organization Contact Card (v1.0.0) | An organization's contact information. |
addresses | The organization's postal addresses. |
emailAddress | The email address of the organization's primary contact. format: email maxLength: 255 |
phoneNumbers | The organization's phone numbers. |
home_url | The organization's home page. format: uri maxLength: 2048 |
organizationIntermediaryService
"unknown"
Intermediary Service (v1.0.0)
Intermediary/non-bank financial institution services.
type: string
enum values: unknown, accounting, fundsManagement, insurance, investment, legal, medical, notary, realEstate, taxPreparation, trustManagement, gambling, securities, loanFinance, pawnBrokerage, travelAgency, vehicleSales, foreignCurrency, preciousMetals, other, notApplicable
organizationPhoneNumbers
{
"primary": "+19105550155",
"mobile": "+19105550150"
}
Organization Phone Numbers (v1.0.0)
The organizations's phone numbers.
Properties
| Name | Description |
|---|---|
Organization Phone Numbers (v1.0.0) | The organizations's phone numbers. |
primary | The primary phone number of the customer. format: phone-number minLength: 5 maxLength: 20 |
secondary | The secondary phone number of the customer. This object is omitted if there is not a secondary phone number. format: phone-number minLength: 5 maxLength: 20 |
mobile | 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 | The alternate phone number of the customer. This object is omitted if there is not an alternate phone number. format: phone-number minLength: 5 maxLength: 20 |
fax | 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 |
primaryPhoneNumberExtension | The phone number extension of the primary phone number. minLength: 1 maxLength: 8 pattern: "^[0-9]{1,8}$" |
organizationRegulatory
{
"atmOperator": true,
"charity": true,
"internetGambling": true,
"marijuanaBusiness": true,
"subjectToWithholdings": false,
"intermediaryServices": [
"unknown"
]
}
Organization Regulatory (v1.0.0)
Responses to regulatory-related questions about the business associated with a new account application.
Properties
| Name | Description |
|---|---|
Organization Regulatory (v1.0.0) | Responses to regulatory-related questions about the business associated with a new account application. |
atmOperator | The organization operates automated teller machines (ATMs). |
charity | Some of the organization's income depends on a charity. |
internetGambling | The organization derives income from internet gambling. |
marijuanaBusiness | The organization derives income from marijuana or other drugs/controlled substances. |
subjectToWithholdings | If true, the organization is subject to tax withholdings.default: false |
intermediaryServices | array: A list of intermediary/non-bank financial institution services provided the organization performs on behalf of others. unique items maxItems: 21 items: string» enum values: unknown, accounting, fundsManagement, insurance, investment, legal, medical, notary, realEstate, taxPreparation, trustManagement, gambling, securities, loanFinance, pawnBrokerage, travelAgency, vehicleSales, foreignCurrency, preciousMetals, other, notApplicable |
organizationYearsOwned
"unknown"
Organization Years Owned (v1.0.0)
The range of years the owners/operators have owned the business.
type: string
enum values: unknown, one, two, three, fourOrMoreYears, other, notApplicable
problemResponse
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists for the given account reference",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Problem Response (v0.4.1)
API problem or error response, as per RFC 9457 application/problem+json.
Properties
| Name | Description |
|---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
type | 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 | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | 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 | 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 | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
productCustomerType
"personal"
Product Customer Type (v1.0.0)
Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).
productCustomerType strings may have one of the following enumerated values:
| Value | Description |
|---|---|
personal | Personal: Retail banking products for personal customers |
business | Business: Commercial banking products for business customers |
both | Personal and Business: Banking products for personal or business customers |
type: string
enum values: personal, business, both
productType
"savings"
Product Type (v2.0.0)
The type (or category) of banking product.
productType strings may have one of the following enumerated values:
| Value | Description |
|---|---|
savings | Savings: Savings Account |
checking | Checking: Checking Account |
cd | CD: Certificate of Deposit Account |
ira | IRA: Individual Retirement Account |
loan | Loan: Loan Account |
creditCard | Credit Card: Credit Card Account |
type: string
enum values: savings, checking, cd, ira, loan, creditCard
readOnlyResourceId
"string"
Read-only Resource Identifier (v1.0.1)
The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
type: string
read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
readOnlyTimestamp
"2021-10-30T19:06:04.250Z"
Read-Only Timestamp (v1.0.0)
A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
type: string(date-time)
read-only format: date-time minLength: 20 maxLength: 30
requiredApplicationDocument
{
"type": "governmentId",
"label": "Driver's License",
"documentTarget": "personal",
"category": "driversLicense",
"requireIfVerified": false
}
Required Document (v1.1.0)
A document which is required from the applicant.
Properties
| Name | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Required Document (v1.1.0) | A document which is required from the applicant. | ||||||||||||||||||
type | The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a governmentId etc.).format: text maxLength: 32 | ||||||||||||||||||
contentType | The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8. minLength: 8 maxLength: 191 pattern: "^[-a-z0-9]{4,48}\\/[-+a-z0-9.]{3,142}$" | ||||||||||||||||||
documentTarget | The target of the relevant product, either business or personal.enum values: personal, business | ||||||||||||||||||
category | Document categories for documents uploaded as part of an account application.
enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, articlesOfOrganization | ||||||||||||||||||
label | User friendly label of the document. format: text maxLength: 120 | ||||||||||||||||||
template_url | If present, the applicant must download the document template from this URL, fill out the document from the template, then upload that completed document. format: uri maxLength: 2048 | ||||||||||||||||||
requireIfVerified | Whether to require this document even if the associated applicant or business has passed verification. If true, this document is always required. |
requiredDocumentCategory
"driversLicense"
Required Document Category (v1.0.0)
Document categories for documents uploaded as part of an account application.
requiredDocumentCategory strings may have one of the following enumerated values:
| Value | Description |
|---|---|
driversLicense | Drivers License |
militaryIdentification | Military Identification |
passport | Passport |
socialSecurityCard | Social Security Card |
stateIdentification | State Identification |
taxForm | Tax Form |
utilityBill | Utility Bill |
articlesOfOrganization | Articles Of Organization |
type: string
enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, articlesOfOrganization
requiredIdentityChallenge
{
"operationId": "createTransfer",
"challengeId": "0504076c566a3cf7009c",
"factors": [
{
"type": "sms",
"labels": [
"9876"
],
"id": "85c0ee5753fcd0b0953f"
},
{
"type": "voice",
"labels": [
"9876"
],
"id": "d089e10a80a8627df37b"
},
{
"type": "voice",
"labels": [
"6754"
],
"id": "10506ecf9d1c2ee00403"
},
{
"type": "email",
"labels": [
"an****nk@example.com",
"an****98@example.com"
],
"id": "e917d671cb2f030b56f1"
},
{
"type": "authenticatorToken",
"labels": [
"Acme fob"
],
"id": "fe6c452d7da0bbb4e407"
},
{
"type": "securityQuestions",
"securityQuestions": {
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
},
"id": "df33c6f88a37d6b3f0a6"
}
]
}
Required Challenge (v1.2.3)
A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.
Properties
| Name | Description |
|---|---|
Required Challenge (v1.2.3) | A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details. |
operationId | The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{6,48}$" |
challengeId | The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
factors | array: (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor.minItems: 1 maxItems: 8 items: object |
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}$"
resourceTrackingId
{
"id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
"createdAt": "2021-06-07T09:11:02.375Z"
}
Resource Tracking Id (v1.0.0)
A tracking ID for a resource. The ID is an opaque string which client applications associate with some other process or resource, such as a promotional campaign.
Properties
| Name | Description |
|---|---|
Resource Tracking Id (v1.0.0) | A tracking ID for a resource. The ID is an opaque string which client applications associate with some other process or resource, such as a promotional campaign. |
id | The unique tracking ID string. format: text minLength: 1 maxLength: 256 pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$" |
createdAt | The date-time the tracking ID was added (if known) in RFC 3338 date-time format, in UTC timezone. read-only format: date-time minLength: 20 maxLength: 30 |
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
trackingId
"string"
- (v1.1.0)*
A unique tracking ID string.
type: string(text)
format: text minLength: 1 maxLength: 256 pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"
userAccountReference
{
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings"
}
User Account Reference (v1.0.2)
The representation of a user account.
Properties
| Name | Description |
|---|---|
User Account Reference (v1.0.2) | The representation of a user account. |
id | The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
firstName | The user's first name. format: text maxLength: 56 |
lastName | The user's last name. format: text maxLength: 56 |
username | The user's login name. format: text maxLength: 20 |
yearsAtAddress
"unknown"
Years at Address (v1.0.0)
Categories for how long the person has been at their present home address.
type: string
enum values: unknown, oneOrFewer, two, three, fourOrMore
Generated by
@apiture/api-doc 3.2.1 on Wed Apr 10 2024 15:36:14 GMT+0000 (Coordinated Universal Time).