Account Applications v0.15.1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
This API manages applications to create new accounts. An account application coordinates the following resources necessary to complete the application:
- account applicant(s) and their identity verification status
- banking product for the new account
- documents (required documents, uploaded instances, approvals)
- acknowledgments the applicant has agreed to (such as terms and conditions for the banking product, electronic consent)
- external funding account and amount (Transfer)
- business verifications (for business accounts)
- workflow/business process used to perform the application process
- application approval
These individual resources will be nested within in the full representation inside the application resource, but are omitted in the summary application representations that are returned in the applications
collection. Only the banking product is required to create a new account application. The application retains snapshots of these objects as they existed when the application was reviewed.
An application may be seeded with initial data. This allows "pre-approved" applications from external sources. All completed applications (whether approved
or rejected
) are retained indefinitely for auditing purposes. Incomplete applications expire after 30 days of inactivity or a period specified by the financial institution in the service configuration.
Each banking product (such as a checking account or money market account) has an association to an account application workflow definition which defines the business process for opening a new account for that product. This workflow is a set of tasks the user must perform in order to open a new account for that product. This service instantiates the workflow, sets the accountApplication
, accountApplicant
, product
, fundingAccount
, and organization
properties of the workflow instance, and starts the workflow.
Note: A task in the workflow typically performs the actual account creation. A valid account is necessary for an initial funding operation to occur.
Each application maintains a state
field which indicates the state of that application: pending
, running
, canceled
, expired
, rejected
, approved
. The pending
state is reserved for future use. The default state when creating a new application is running
'
Allowed state transitions are:
running
→canceled
|expired
|approved
|rejected
blocked
→running
|canceled
|expired
|approved
|rejected
The service will also change an application's state from blocked
to running
once the condition that is blocking the application has changed (such as completion of workflow tasks or financial institution approvals.)
This API also manages enrollments, which represent a new user enrolling in on-line digital banking. Enrollments consist of collecting personal information (name, address, phone, email, tax ID) and other personal data. Enrollments also support Customer Identification Program regulatory requirements, also known as "Know Your Customer", by verifying the user's identity and ensuring they are not involved with fraud or other risk factors. Enrollments are used when new users register in response to invitations to become joint owners or authorized signers on existing accounts. State transitions for enrollments are similar to those for applications.
Note: This API uses the base path /accountApplications
to avoid confusion with software applications.
Download OpenAPI Definition (YAML)
Base URLs:
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the
API-Key: {api-key}
request header.
- OAuth2 authentication (
accessToken
)- OAuth2 client access token authentication. The client authenticates against the server at
authorizationUrl
, passing the client's privateclientId
(and optionalclientSecret
) as part of this flow. The client obtains an access token from the server attokenUrl
. It then passes the received access token via theAuthorization: Bearer {access-token}
header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires. - Flow:
authorizationCode
- Authorization URL = https://auth.apiture.com/oauth2/authorize
- Token URL = http://auth.apiture.com/auth/oauth2/token
- OAuth2 client access token authentication. The client authenticates against the server at
Scope | Scope Description |
---|---|
banking/read |
Read access to accounts and account-related resources such as transfers and transactions. |
banking/write |
Write (update) access to accounts and account-related resources such as transfers and transactions. |
banking/delete |
Delete access to editable accounts and account-related resources such as transfers. |
banking/readBalance |
Read access to account balances. This must be granted in addition to the banking/read scope in order to view balances, but is included in the banking/full scope. |
banking/full |
Full access to accounts and account-related resources such as transfers and transactions. |
profiles/read |
Read access to user and contact related resources. |
profiles/write |
Write (update) access to user and contact related resources. |
profiles/delete |
Delete access to user and contact related resources. |
profiles/readPii |
Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the profiles/read scope in order to read such data, but is included in the profiles/full scope. |
profiles/full |
Full access to user and contact related resources. |
data/read |
Read access to non-account, non-profile data. |
data/write |
Write (update) access to non-account, non-profile data. |
data/delete |
Delete access to non-account, non-profile data. |
data/full |
Full access to non-account, non-profile data. |
admin/read |
Read access to system configuration. |
admin/write |
Write (update) access to system configuration. |
admin/delete |
Delete access to system configuration. |
admin/full |
Full access to system configuration. |
Account Application
Application for a new banking account
getRunningApplications
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/runningApplications \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/runningApplications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/runningApplications',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/runningApplications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/runningApplications',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/runningApplications', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/runningApplications");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/runningApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of active, running account applications
GET /runningApplications
Return a paginated sortable filterable searchable collection of active running account applications. The links in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is running
.
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of account application representations to return in this page. |
sortBy (query) |
string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2 . |
filter (query) |
string Optional filter criteria. See filtering. |
q (query) |
string Optional search string. See searching. |
state (query) |
string Subset the accounts or external accounts collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending will match only items whose state is pending ; ?state=running|canceled will match items whose state is running or canceled . This is combined with an implicit and with other filters if they are used. See filtering. Enumerated values: pending running blocked canceled expired rejected approved |
name (query) |
string Subset the accounts or external accounts collection to those with this name value. Use |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/accountApplications/applications/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "account applications",
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/applications?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/applications?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/applications"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "6 Month CD",
"state": "approved"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: applications |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
getBlockedApplications
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/blockedApplications \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/blockedApplications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/blockedApplications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/blockedApplications', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/blockedApplications");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/blockedApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of blocked account applications
GET /blockedApplications
Return a paginated sortable filterable searchable collection of active running account applications. The links in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is blocked
.
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of account application representations to return in this page. |
sortBy (query) |
string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2 . |
filter (query) |
string Optional filter criteria. See filtering. |
q (query) |
string Optional search string. See searching. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/accountApplications/applications/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "account applications",
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/applications?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/applications?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/applications"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "6 Month CD",
"state": "approved"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: applications |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
getApplications
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/applications', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/applications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of account applications
GET /applications
Return a paginated sortable filterable searchable collection of account applications. The links in the response include pagination links.
Not all nested objects are supported for filtering or sorting applications. The following fields may be used: accountName
, applicantName
, productName
, organizationName',
state,
createdAt,
completedAt`
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of account application representations to return in this page. |
sortBy (query) |
string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2 . |
applicant (query) |
string Filter applications by applicant. The value must be an applicant's contact URI, not the URI of a user. (To find applications for a user, pass the href from the apiture:contact link on the user resource.) An application resource is included in the response if and only if the named contact is among the application's applicants . This query parameter exists for administrator use. The collection is automatically filtered to applications which a user created for non-administrator users. |
filter (query) |
string Optional filter criteria. See filtering. |
q (query) |
string Optional search string. See searching. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/accountApplications/applications/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "account applications",
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/applications?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/applications?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/applications"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "6 Month CD",
"state": "approved"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: applications |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/applications \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"accountName": "My checking account",
"_links": {
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
}
},
"applicants": [
{
"username": "Snowqueen123",
"contact": {
"firstName": "Elsa",
"lastName": "Snowqueen",
"_links": {
"self": {
"href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
}
}
},
"role": {
"name": "primaryUser",
"label": "Primary User",
"_links": {
"self": {
"href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
}
}
}
}
],
"products": [
{
"name": "Personal Savings",
"_links": {
"self": {
"href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
}
}
}
]
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/applications',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/applications', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/applications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new account application
POST /applications
Create a new account application. This also creates and starts the workflow that is associated with the primary banking product in the request body. The client should execute any interactive workflow tasks until the workflow reaches a terminal state and the system approves or rejects the application or the user cancels the application. Users can have only one running application at a time.
Body parameter
{
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"accountName": "My checking account",
"_links": {
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
}
},
"applicants": [
{
"username": "Snowqueen123",
"contact": {
"firstName": "Elsa",
"lastName": "Snowqueen",
"_links": {
"self": {
"href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
}
}
},
"role": {
"name": "primaryUser",
"label": "Primary User",
"_links": {
"self": {
"href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
}
}
}
}
],
"products": [
{
"name": "Personal Savings",
"_links": {
"self": {
"href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
}
}
}
]
}
Parameters
Parameter | Description |
---|---|
body (body) |
createApplication (required) The data necessary to create a new account application. |
Example responses
201 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
201 | Location string uri |
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme ://host | |
201 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
getApplication
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string
var headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-None-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
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/hal+json"},
"If-None-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this account application
GET /applications/{applicationId}
Return a HAL representation of this account application resource.
Parameters
Parameter | Description |
---|---|
applicationId (path) |
string (required) The unique identifier of this application. This is an opaque string. |
If-None-Match (header) |
string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: application |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such application resource at the specified {applicationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this account application resource. |
updateApplication
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this account application
PUT /applications/{applicationId}
Perform a complete replacement of this account application.
Body parameter
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Parameters
Parameter | Description |
---|---|
applicationId (path) |
string (required) The unique identifier of this application. This is an opaque string. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
application (required) |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such application resource at the specified {applicationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this account application resource. |
patchApplication
Code samples
# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this account application
PATCH /applications/{applicationId}
Perform a partial update of this account application. Fields which are omitted are not updated. Nested _embedded
and _links
are ignored if included.
Body parameter
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Parameters
Parameter | Description |
---|---|
applicationId (path) |
string (required) The unique identifier of this application. This is an opaque string. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
application (required) |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such application resource at the specified {applicationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this account application resource. |
deleteApplication
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete an unused or expired application
DELETE /applications/{applicationId}
Delete this account application resource. An application may only be deleted by the user if its state
is pending
, or by a financial institution if its state
is expired
.
Parameters
Parameter | Description |
---|---|
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
applicationId (path) |
string (required) The unique identifier of this application. This is an opaque string. |
Example responses
409 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://api.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The resource was deleted successfully. |
Status | Description |
---|---|
409 | Conflict |
Conflict. An application not be deleted by the applicant if the state is anything other than pending , or by the financial institution if the state is expired . | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Account Application Actions
Operations to update the state of an application
expireApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
method: 'post',
data: '?application=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
params: {
'application' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/expiredApplications', params={
'application': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/expiredApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Expire an application
POST /expiredApplications
Update an application by adding it to the set of expired applications. This changes the state
property of the application to expired
. This operation is available via the apiture:expire
link on the application resource, if and only if the application is eligible for the expire operation. The response is the updated representation of the application. The If-Match
request header value, if passed, must match the current entity tag value of the application.
This operation is valid if the current state of the application is running
, or blocked
. This operation does nothing if the state is already expired
. This is a terminal state: the application state cannot be changed once it has expired.
Parameters
Parameter | Description |
---|---|
application (query) |
string (required) A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The application was updated and its state changed to expired . | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The application parameter was malformed or does not refer to an existing or accessible application. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
rejectApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/rejectedApplications',
method: 'post',
data: '?application=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/rejectedApplications',
params: {
'application' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/rejectedApplications', params={
'application': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/rejectedApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Reject an application
POST /rejectedApplications
Reject an account application. This changes the state
property of the application to rejected
. This operation is available via the apiture:reject
link on the application resource, if and only if the application is eligible for the reject operation. The response is the updated representation of the application. The If-Match
request header value, if passed, must match the current entity tag value of the application.
This operation is valid if the current state of the application is running
, or blocked
. This operation does nothing if the state is already rejected
. This is a terminal state: the application state cannot be changed once it has been rejected.
Parameters
Parameter | Description |
---|---|
application (query) |
string (required) A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The application was updated and its state changed to rejected . | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The application parameter was malformed or does not refer to an existing or accessible application. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
approveApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/approvedApplications',
method: 'post',
data: '?application=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/approvedApplications',
params: {
'application' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/approvedApplications', params={
'application': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/approvedApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Approve an application
POST /approvedApplications
Approve an account application. This changes the state
property of the application to approved
. This operation is available via the apiture:approve
link on the application resource, if and only if the application is eligible for the approve operation. The response is the updated representation of the application. The If-Match
request header value, if passed, must match the current entity tag value of the application.
This operation is valid if the current state of the application is running
, or blocked
. This operation does nothing if the state is already approved
. This is a terminal state: the application state cannot be changed once it has been approved.
Parameters
Parameter | Description |
---|---|
application (query) |
string (required) A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The application was updated and its state changed to approved . | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The application parameter was malformed or does not refer to an existing or accessible application. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
cancelApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/canceledApplications',
method: 'post',
data: '?application=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/canceledApplications',
params: {
'application' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/canceledApplications', params={
'application': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/canceledApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Cancel an application
POST /canceledApplications
Cancel an account application. This changes the state
property of the application to canceled
. This also cancels the application workflow. This operation is available via the apiture:cancel
link on the application resource, if and only if the application is eligible for the cancel operation. The response is the updated representation of the application. The If-Match
request header value, if passed, must match the current entity tag value of the application.
This operation is valid if the current state of the application is running
, or blocked
. This operation does nothing if the state is already canceled
. This is a terminal state: the application state cannot be changed once it has been canceled.
Parameters
Parameter | Description |
---|---|
application (query) |
string (required) A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The application was updated and its state changed to canceled . | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The application parameter was malformed or does not refer to an existing or accessible application. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
startApplication
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/runningApplications?application=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/runningApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/runningApplications',
method: 'post',
data: '?application=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/runningApplications?application=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/runningApplications',
params: {
'application' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/runningApplications', params={
'application': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/runningApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/runningApplications", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Start an application
POST /runningApplications
Start an application by adding it to the set of running applications. This changes the state
property of the application to running
. This operation is available via the apiture:start
link on the application resource, if and only if the application is eligible for the start operation. The response is the updated representation of the application. The If-Match
request header value, if passed, must match the current entity tag value of the application.
This operation is only valid if the current state of the application is blocked
. This operation does nothing if the state is already running
.
Parameters
Parameter | Description |
---|---|
application (query) |
string (required) A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The application was updated and its state changed to running . | |
Schema: application |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The application parameter was malformed or does not refer to an existing or accessible application. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
Enrollment
Operations to update an enrollment
getEnrollments
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/enrollments \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/enrollments HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/enrollments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/enrollments', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/enrollments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of enrollments
GET /enrollments
Return a paginated sortable filterable searchable collection of enrollments. The links in the response include pagination links.
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first enrollment item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of enrollment representations to return in this page. |
sortBy (query) |
string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2 . |
filter (query) |
string Optional filter criteria. See filtering. |
q (query) |
string Optional search string. See searching. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/accountApplications/enrollments/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/enrollments?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/enrollments?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/enrollments?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/enrollments"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "approved"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: enrollments |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createEnrollment
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/enrollments \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/enrollments HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
]
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/enrollments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/enrollments', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/enrollments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new enrollment
POST /enrollments
Create a new enrollment. Creating an enrollment will create and start the workflow that is defined for enrollment in digital banking. The client should execute any interactive workflow tasks until the workflow reaches a terminal state and the system approves or rejects the application or the user cancels the application. A user may have only one active enrollment at a time.
Body parameter
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
]
}
Parameters
Parameter | Description |
---|---|
body (body) |
createEnrollment (required) The data necessary to create a new enrollment. |
Example responses
201 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
201 | Location string uri |
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme ://host | |
201 | ETag string |
An entity tag which may be passed in the If-Match request header for PUT or PATCH operations which update the resource. |
getEnrollment
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string
var headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-None-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
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/hal+json"},
"If-None-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this enrollment
GET /enrollments/{enrollmentId}
Return a HAL representation of this enrollment resource.
Parameters
Parameter | Description |
---|---|
enrollmentId (path) |
string (required) The unique identifier of this enrollment. This is an opaque string. |
If-None-Match (header) |
string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned. |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: enrollment |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such enrollment resource at the specified {enrollmentId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this enrollment resource. |
updateEnrollment
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this enrollment
PUT /enrollments/{enrollmentId}
Perform a complete replacement of this enrollment.
Body parameter
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}
Parameters
Parameter | Description |
---|---|
enrollmentId (path) |
string (required) The unique identifier of this enrollment. This is an opaque string. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
enrollment (required) |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such enrollment resource at the specified {enrollmentId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this enrollment resource. |
patchEnrollment
Code samples
# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this enrollment
PATCH /enrollments/{enrollmentId}
Perform a partial update of this enrollment. Fields which are omitted are not updated. Nested _embedded
and _links
are ignored if included.
Body parameter
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}
Parameters
Parameter | Description |
---|---|
enrollmentId (path) |
string (required) The unique identifier of this enrollment. This is an opaque string. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
enrollment (required) |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such enrollment resource at the specified {enrollmentId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this enrollment resource. |
deleteEnrollment
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
var headers = {
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this enrollment resource
DELETE /enrollments/{enrollmentId}
Delete this enrollment resource and any resources that are owned by it.
Parameters
Parameter | Description |
---|---|
enrollmentId (path) |
string (required) The unique identifier of this enrollment. This is an opaque string. |
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The resource was deleted successfully. |
Enrollment Actions
Operations which act on enrollments
rejectEnrollment
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
method: 'post',
data: '?enrollment=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
params: {
'enrollment' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments', params={
'enrollment': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/rejectedEnrollments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Reject an enrollment
POST /rejectedEnrollments
Reject an enrollment. This changes the state
property of the enrollment to rejected
. This operation is available via the apiture:reject
link on the enrollment resource, if and only if the enrollment is eligible for the reject operation. The response is the updated representation of the enrollment. The If-Match
request header value, if passed, must match the current entity tag value of the enrollment.
This operation is valid if the current state of the enrollment is running
, or blocked
. This operation does nothing if the state is already rejected
. This is a terminal state: the enrollment state cannot be changed once it has been rejected. Only service or administrator can call this operation, not end users.
Parameters
Parameter | Description |
---|---|
enrollment (query) |
string (required) A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The enrollment was updated and its state changed to rejected . | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to reject the enrollment is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
approveEnrollment
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/approvedEnrollments',
method: 'post',
data: '?enrollment=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/approvedEnrollments',
params: {
'enrollment' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/approvedEnrollments', params={
'enrollment': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/approvedEnrollments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Approve an enrollment
POST /approvedEnrollments
Approve an enrollment. This changes the state
property of the enrollment to approved
. This operation is available via the apiture:approve
link on the enrollment resource, if and only if the enrollment is eligible for the approve operation, if the user has completed all enrollment requirements such as passing identity verification and accepting digital banking terms of use and the financial institution's privacy policy. The response is the updated representation of the enrollment. The If-Match
request header value, if passed, must match the current entity tag value of the enrollment.
This operation is valid if the current state of the enrollment is running
, or blocked
. This operation does nothing if the state is already approved
. This is a terminal state: the enrollment state cannot be changed once it has been approved. This operation can be called by services or administrators only, not end users.
Parameters
Parameter | Description |
---|---|
enrollment (query) |
string (required) A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The enrollment was updated and its state changed to approved . | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to approve the enrollment is not allowed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
cancelEnrollment
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/canceledEnrollments',
method: 'post',
data: '?enrollment=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/canceledEnrollments',
params: {
'enrollment' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/accountApplications/canceledEnrollments', params={
'enrollment': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/canceledEnrollments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Cancel an enrollment
POST /canceledEnrollments
Cancel an enrollment. This changes the state
property of the enrollment to canceled
. This operation is available via the apiture:cancel
link on the enrollment resource, if and only if the enrollment is eligible for the cancel operation. The response is the updated representation of the enrollment. The If-Match
request header value, if passed, must match the current entity tag value of the enrollment.
This operation is valid if the current state of the enrollment is running
, or blocked
. This operation does nothing if the state is already canceled
. This is a terminal state: the enrollment state cannot be changed once it has been canceled.
Parameters
Parameter | Description |
---|---|
enrollment (query) |
string (required) A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The enrollment was updated and its state changed to canceled . | |
Schema: enrollment |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to cancel the enrollment is not allowed. The _error field in the response will contain details about the request error. |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
API
Endpoints which describe this API
getApi
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/ \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/accountApplications/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/accountApplications/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/");
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/hal+json"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Top-level resources and operations in this API
GET /
Return links to the top-level resources and operations in this API.
Example responses
200 Response
{
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0",
"_profile": "http://localhost:8080/schemas/common/root/v1.0.0/profile.json",
"_links": {}
}
Responses
getApiDoc
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/apiDoc \
-H 'Accept: application/json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/accountApplications/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
var headers = {
'Accept':'application/json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/apiDoc',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/accountApplications/apiDoc',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/apiDoc',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/apiDoc', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/apiDoc");
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"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/apiDoc", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return API definition document
GET /apiDoc
Return the OpenAPI document that describes this API.
Example responses
200 Response
{}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: Inline |
Response Schema
Configuration
A set of endpoints that allows for the creation and retrieval of configuration options specific to this service
getConfiguration
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Configuration definition for this API
GET /configurations
Returns the configuration for this API
Example responses
200 Response
{
"_links": {
"self": {
"href": "/accountApplications/configurations/"
},
"apiture:groups": {
"href": "/accountApplications/configurations/groups"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configuration |
getConfigurationGroups
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations/groups HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of configuration groups
GET /configurations/groups
Return a paginated sortable filterable searchable collection of configuration groups. The links in the response include pagination links.
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of configuration group representations to return in this page. |
sortBy (query) |
string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2 . |
filter (query) |
string Optional filter criteria. See filtering. |
q (query) |
string Optional search string. See searching. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroups/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "configurationGroups",
"_links": {
"self": {
"href": "/accountApplications/configurations/groups?start=10&limit=10"
},
"first": {
"href": "/accountApplications/configurations/groups?start=0&limit=10"
},
"next": {
"href": "/accountApplications/configurations/groups?start=20&limit=10"
},
"collection": {
"href": "/accountApplications/configurations/groups"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/configurations/groups/basic"
},
"apiture:configuration": {
"href": "/configurations"
}
},
"name": "basic",
"label": "Basic Settings",
"description": "The basic settings for the Applications API"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configurationGroups |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
getConfigurationGroup
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName} \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string
var headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-None-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}");
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/hal+json"},
"If-None-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this configuration group
GET /configurations/groups/{groupName}
Return a HAL representation of this configuration group resource.
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
If-None-Match (header) |
string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/configurations/groups/basic"
},
"apiture:configuration": {
"href": "/configurations"
}
},
"name": "basic",
"label": "Basic Settings",
"description": "The basic settings for the Applications API",
"schema": {
"type": "object",
"properties": {
"defaultPersonalWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for personal product types"
},
"defaultBusinessWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for business product types"
}
}
},
"values": {
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configurationGroup |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-None-Match request header for GET operations for this configuration group resource. |
getConfigurationGroupSchema
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string
var headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-None-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema");
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/hal+json"},
"If-None-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch the schema for this configuration group
GET /configurations/groups/{groupName}/schema
Return a HAL representation of this configuration group schema resource.
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
If-None-Match (header) |
string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned. |
Example responses
200 Response
{
"type": "object",
"properties": {
"defaultPersonalWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for personal product types"
},
"defaultBusinessWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for business product types"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configurationSchema |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT |
getConfigurationGroupValues
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string
var headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-None-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-None-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values");
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/hal+json"},
"If-None-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch the values for the specified configuration group
GET /configurations/groups/{groupName}/values
Return a representation of this configuration group values resource.
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
If-None-Match (header) |
string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned. |
Example responses
200 Response
{
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configurationValues |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT |
updateConfigurationGroupValues
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update the values for the specified configuration group
PUT /configurations/groups/{groupName}/values
Perform a complete replacement of this set of values
Body parameter
{
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
If-Match (header) |
string (required) The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
configurationValues (required) |
Example responses
200 Response
{
"type": "object",
"properties": {
"defaultPersonalWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for personal product types"
},
"defaultBusinessWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for business product types"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: configurationSchema |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT |
getConfigurationGroupValue
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}");
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/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a single value associated with the specified configuration group
GET /configurations/groups/{groupName}/values/{valueName}
Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group.
The response is always a JSON value which can be parsed with a strict JSON parser. The response may be
- a primitive number, boolean, or quoted JSON string.
- a JSON array.
- a JSON object.
null
.
Examples:
"a string configuration value"
120
true
null
{ "borderWidth": 8, "foregroundColor": "blue" }
To update a specific value, use PUT /accountApplications/configurations/groups/{groupName}/values/{valueName}
(operation updateConfigurationGroupValue
).
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
valueName (path) |
string (required) The unique name of a value in a configuration group. This is the name of the value in the schema . A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']* |
Example responses
200 Response
"string"
Responses
Status | Description |
---|---|
200 | OK |
OK. The value of the named configuration value as a JSON string, number, boolean, array, or object. | |
Schema: string |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is either no such configuration group resource at the specified {groupName} or no such value at the specified {valueName} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource. |
updateConfigurationGroupValue
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/hal+json',
'Accept' => 'application/hal+json',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update a single value associated with the specified configuration group
PUT /configurations/groups/{groupName}/values/{valueName}
Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema
. The request body must conform to the configuration group's schema for the named {valueName}
. This operation is idempotent.
The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be
- a primitive number, boolean, or quoted JSON string.
- a JSON array.
- a JSON object.
null
.
Examples:
"a string configuration value"
120
true
null
{ "borderWidth": 8, "foregroundColor": "blue" }
To fetch specific value, use GET /accountApplications/configurations/groups/{groupName}/values/{valueName}
(operation getConfigurationGroupValue
).
Body parameter
"string"
Parameters
Parameter | Description |
---|---|
groupName (path) |
string (required) The unique name of this configuration group. |
valueName (path) |
string (required) The unique name of a value in a configuration group. This is the name of the value in the schema . A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']* |
body (body) |
string (required) The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object. |
Example responses
200 Response
"string"
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: string |
Status | Description |
---|---|
403 | Forbidden |
Access denied. Only user allowed to update configurations is an admin. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource. |
Schemas
createApplication
{
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"accountName": "My checking account",
"_links": {
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
}
},
"applicants": [
{
"username": "Snowqueen123",
"contact": {
"firstName": "Elsa",
"lastName": "Snowqueen",
"_links": {
"self": {
"href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
}
}
},
"role": {
"name": "primaryUser",
"label": "Primary User",
"_links": {
"self": {
"href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
}
}
}
}
],
"products": [
{
"name": "Personal Savings",
"_links": {
"self": {
"href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
}
}
}
]
}
Create Account Application (Version v1.0.0
)
Representation of the request used to create a new account application. This does not create an account_, just an _application. When the application is completed and approved, the account will be created. The request must contain the following contents:
products
- an array of one or more Product objects which determine the banking product for the new account(s). The first(required) item in the array is the primary account; others are optional secondary accounts in a product bundle. The products must be an active internal account products that is eligible for opening new accounts. ("newAccountAvailability": "available"
)
These objects passed in the request may be complete object representations, or they may be "thin" objects with only HAL _links
with a self
link containing the object URL; the application resource will fetch these objects. Creating an application will instantiate a workflow instance, based on a workflow definition that is associated with the primary banking product in the application. The client application should process that workflow instance and present any interactive tasks which are available to run, and continue until the workflow is done.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
accountName | string The name of new account. If initially blank, this will be initialized from the name of the first product. maxLength: 128
|
fundingAmount | money How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. |
applicants | [applicant] The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. minItems: 1
|
requiredDocuments | [requiredDocument] An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of incorporation (for business accounts) etc. |
documents | [document] 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 incorporation (for business accounts) etc. |
approvals | [approval] All of the Approval objects which are associated with this enrollment or application. The apiture:approve , apiture:reject , apiture:waive , and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
|
products | [summaryProduct] (required) The bank product(s) for this account. The first item in the array is the primary product for the new account. The remaining optional items in the array are secondary associated products. minItems: 1
|
organization | organization The optional organization for a non-personal (business) account. |
organizationVerification | businessVerifications The results of verifying a business or other organization. |
organizationApprovals | [approval] Any Approvals for administrator verification of the organization. |
accountApproval | approval An Approval object which the reviewer can use to approve or reject the entire account application. The apiture:approve and apiture:reject links in the resource may be used to reject or approve the applications via POST operations (no request body).
|
fundingAccount | transferAccount Contact information about the applicant. |
newAccounts | [transferAccount] New accounts opened via this application. This array has a one-to-one mapping to the products array. Use the self link in each item's _links to access each account.
|
summaryApplication
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
}
}
}
Account Application Summary (Version v1.0.0
)
Summary representation of an account application resource in account applications collections. This representation normally does not contain any _embedded
objects. If needed, call the GET
operation on the item's self
link to get _embedded
objects.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
applicantName | string The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user. read-only
minLength: 1
maxLength: 128
|
workflowState | string The state of the embedded application workflow. This is derived and immutable. read-only
minLength: 1
maxLength: 16
|
state | string The state of the enrollment or application. The values mean:
read-only
|
flaggedForReview | boolean true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
|
createdAt | string(date-time) The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
completedAt | string(date-time) The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
accountName | string The name of new account. If initially blank, this will be initialized from the name of the first product. maxLength: 128
|
fundingAmount | money How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. |
_id | string The unique identifier for this application. This is an immutable opaque string. read-only
|
productName | string The name of the banking product associated with this new account application. This is derived from the first product in the products array and is immutable.
read-only
minLength: 1
maxLength: 128
|
organizationName | string The name of the organization, if this is an application for a business account. This will be derived from the organization resource, if present. read-only
minLength: 1
maxLength: 128
|
application
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
"applicantName": "Elsa Snowqueen",
"accountName": "My Premiere Savings",
"productName": "Premiere Savings",
"fundingAmount": {
"value": "1500.00",
"currency": "USD"
},
"state": "running",
"workflowState": "running",
"createdAt": {},
"fundingAccount": {
"title": "Elsa Snowqueen",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"full": "9876543210",
"masked": "*************3210"
}
},
"organization": {},
"applicants": [],
"products": [],
"documents": [],
"accountApproval": {
"_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
"label": "Account Approval: Premiere Savings, Elsa Snowqueen",
"state": "open",
"done": false,
"typeName": "accountApplication",
"type": {
"_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
"name": "accountApplication",
"label": "Account Application",
"domain": "https://api.apiture.com/approvals",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
},
"createdAt": "2019-12-14T06:41:35.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
}
}
},
"acknowledgments": [],
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:product": {
"href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
},
"apiture:workflow": {
"href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
},
"apiture:fundingAccount": {
"href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
},
"apiture:applicant": {
"href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
},
"apiture:organization": {
"href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
},
"apiture:approval": {
"href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
}
}
}
Account Application (Version v1.0.0
)
An application for a new account. The resource contains summary fields that identify the account applicant, the primary product, and the state of the applications. The nested arrays and objects contains related resources which support the application: applicants
and their identity verification, related products
, documents, the organization
(for business accounts), etc. Links on an application include:
apiture:workflow
-GET
this URL to access the application's workflow.apiture:approval
-GET
this URL to access the application's approval.apiture:product
-GET
this URL to access the application's banking product.apiture:applicant
-GET
this URL to access the application's primary applicant.apiture:organization
-GET
this URL to access the application's organization (the owning business for business accounts).apiture:fundingAccount
-GET
this URL to access the funding account.apiture:expire
-POST
to this URL when the application expires.apiture:reject
-POST
to this URL to reject an application.apiture:approve
-POST
to this URL to approve an application.apiture:cancel
-POST
to this URL to cancel an application.apiture:start
-POST
to this URL to start the application's workflow.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
applicantName | string The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user. read-only
minLength: 1
maxLength: 128
|
workflowState | string The state of the embedded application workflow. This is derived and immutable. read-only
minLength: 1
maxLength: 16
|
state | string The state of the enrollment or application. The values mean:
read-only
|
flaggedForReview | boolean true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
|
createdAt | string(date-time) The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
completedAt | string(date-time) The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
accountName | string The name of new account. If initially blank, this will be initialized from the name of the first product. maxLength: 128
|
fundingAmount | money How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. |
_id | string The unique identifier for this application. This is an immutable opaque string. |
productName | string The name of the banking product associated with this new account application. This is derived from the first product in the products array and is immutable.
read-only
minLength: 1
maxLength: 128
|
organizationName | string The name of the organization, if this is an application for a business account. This will be derived from the organization resource, if present. read-only
minLength: 1
maxLength: 128
|
applicants | [applicant] The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. minItems: 1
|
requiredDocuments | [requiredDocument] An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of incorporation (for business accounts) etc. |
documents | [document] 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 incorporation (for business accounts) etc. |
approvals | [approval] All of the Approval objects which are associated with this enrollment or application. The apiture:approve , apiture:reject , apiture:waive , and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
|
products | [summaryProduct] The bank product(s) for this account. The first item in the array is the primary product for the new account. The remaining optional items in the array are secondary associated products. minItems: 1
|
organization | organization The optional organization for a non-personal (business) account. |
organizationVerification | businessVerifications The results of verifying a business or other organization. |
organizationApprovals | [approval] Any Approvals for administrator verification of the organization. |
accountApproval | approval An Approval object which the reviewer can use to approve or reject the entire account application. The apiture:approve and apiture:reject links in the resource may be used to reject or approve the applications via POST operations (no request body).
|
fundingAccount | transferAccount Contact information about the applicant. |
newAccounts | [transferAccount] New accounts opened via this application. This array has a one-to-one mapping to the products array. Use the self link in each item's _links to access each account.
|
completedTaskCount | number(int32) The number of visible workflow tasks which have been completed. read-only
|
runningTaskCount | number(int32) The number of visible workflow tasks which are currently running. read-only
|
pendingTaskCount | number(int32) The number of visible workflow tasks which are still pending. read-only
|
blockedTaskCount | number(int32) The number of visible workflow tasks which are blocked. read-only
|
canceledTaskCount | number(int32) The number of visible workflow tasks which have been canceled. read-only
|
expiresAt | string(date-time) The date-time when the application expires. This is in [RFC 3339] (https://tools.ietf.org/html/rfc3339) UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ).
read-only
|
Links
Representations using this application
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
apiture:expire | Expire an application | POST |
apiture:reject | Reject an application | POST |
apiture:approve | Approve an application | POST |
apiture:cancel | Cancel an application | POST |
apiture:start | Start an application | POST |
apiture:product | GET |
|
apiture:applicant | GET |
|
apiture:organization | GET |
|
apiture:fundingAccount | GET |
|
apiture:workflow | GET |
|
apiture:approval | GET |
createEnrollment
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
]
}
Create an Enrollment (Version v1.0.0
)
Representation of the request to enroll a user in digital banking. Creating an enrollment will instantiate a workflow instance, based on a workflow definition that is configured for new user enrollment. This will typically apply the financial institution's Customer Identification Program (CIP) process, a.k.a. their Know Your Customer process. The client application should monitor that workflow instance and present any interactive tasks which are available to run, and continue until the workflow is done.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
applicant | applicant The applicant seeking to enroll in digital banking. If omitted, the service will create the applicant, based on the current user. Warning: This property is deprecated. Use applicants .
|
applicants | [applicant] The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. minItems: 1
|
requiredDocuments | [requiredDocument] An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of incorporation (for business accounts) etc. |
documents | [document] 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 incorporation (for business accounts) etc. |
approvals | [approval] All of the Approval objects which are associated with this enrollment or application. The apiture:approve , apiture:reject , apiture:waive , and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
|
summaryEnrollment
{
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Digital Banking User Enrollment Summary (Version v1.0.0
)
Representation of enrollments in the collection.
Properties
Name | Description |
---|---|
applicantName | string The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user. read-only
minLength: 1
maxLength: 128
|
workflowState | string The state of the embedded application workflow. This is derived and immutable. read-only
minLength: 1
maxLength: 16
|
state | string The state of the enrollment or application. The values mean:
read-only
|
flaggedForReview | boolean true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
|
createdAt | string(date-time) The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
completedAt | string(date-time) The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
applicant | applicant The applicant seeking to enroll in digital banking. If omitted, the service will create the applicant, based on the current user. Warning: This property is deprecated. Use applicants .
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this application. This is an immutable opaque string. read-only
|
enrollment
{
"applicants": [
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
],
"requiredDocuments": [
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
],
"documents": [
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
],
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"applicantName": "Elsa Snowqueen",
"workflowState": "running",
"state": "running",
"flaggedForReview": false,
"createdAt": "2019-11-25T16:08:24Z",
"completedAt": "2019-11-25T16:08:24Z",
"applicant": {
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
},
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string"
}
Digital Banking User Enrollment (Version v1.0.0
)
Representation of the request to enroll a user in digital banking.
Links on an enrollment include:
apiture:workflow
-GET
this URL to access the enrollment's workflow.apiture:approval
-GET
this URL to access the enrollment's approval.apiture:start
-POST
to this URL to start the enrollment's workflow.apiture:reject
-POST
to this URL to reject an enrollment.apiture:approve
-POST
to this URL to approve an enrollment.apiture:cancel
-POST
to this URL to cancel an enrollment.
Properties
Name | Description |
---|---|
applicants | [applicant] The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. minItems: 1
|
requiredDocuments | [requiredDocument] An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of incorporation (for business accounts) etc. |
documents | [document] 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 incorporation (for business accounts) etc. |
approvals | [approval] All of the Approval objects which are associated with this enrollment or application. The apiture:approve , apiture:reject , apiture:waive , and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
|
applicantName | string The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user. read-only
minLength: 1
maxLength: 128
|
workflowState | string The state of the embedded application workflow. This is derived and immutable. read-only
minLength: 1
maxLength: 16
|
state | string The state of the enrollment or application. The values mean:
read-only
|
flaggedForReview | boolean true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
|
createdAt | string(date-time) The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
completedAt | string(date-time) The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
|
applicant | applicant The applicant seeking to enroll in digital banking. If omitted, the service will create the applicant, based on the current user. Warning: This property is deprecated. Use applicants .
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this application. This is an immutable opaque string. read-only
|
Links
Representations using this enrollment
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
| (Unknown)(Unknown) | |
apiture:reject | Reject an enrollment | POST |
apiture:approve | Approve an enrollment | POST |
apiture:cancel | Cancel an enrollment | POST |
apiture:workflow | GET |
|
apiture:approval | GET |
enrollments
{
"_profile": "https://api.apiture.com/schemas/accountApplications/enrollments/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/enrollments?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/enrollments?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/enrollments?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/enrollments"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"state": "approved"
}
]
}
}
Enrollment Collection (Version v1.0.0
)
Collection digital banking enrollments. The items in the collection are ordered in the _embedded
object with name items
. The top-level _links
object may contain pagination links: self
, next
, prev
, first
, last
, collection
.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object Embedded resources. |
» items | [summaryEnrollment] An array containing a page of account application items. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
count | integer The number of items in the collection. This value is optional and my be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
start | integer The start index of this page of items. |
limit | integer The maximum number of items per page. |
name | string The name of the collection. |
transferAccount
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"title": "John Smith",
"institutionName": "3rd Party Bank",
"routingNumber": "021000021",
"accountNumbers": {
"masked": "*************3210",
"full": "9876543210"
},
"verificationReport": {
"state": "failed",
"accountRiskFactors": [
{
"riskCode": 101,
"description": "Account owner first name does not match"
},
{
"riskCode": 102,
"description": "Account owner last name does not match"
},
{
"riskCode": 103,
"description": "Account owner zip code does not match"
}
]
}
}
Transfer Account (Version v1.0.0
)
Summary properties of the source or target account for a transfer.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
title | string The title of the account. Traditionally, this is the name of the account holder. maxLength: 512
|
institutionName | string The name of the financial institution. read-only
minLength: 2
maxLength: 128
|
routingNumber | string The account routing number which identifies the financial institution. The full routing number and full account number are required to fully identify the account. read-only
minLength: 9
maxLength: 9
|
accountNumbers | accountNumbers The account numbers for this account read-only
|
verificationReport | verificationReport A verification report is an additional layer of validation that can be run against a verification resource. It uses available account aggregation data from an external provider to generate a pass/fail result based on pre-configured risk factors. read-only
|
applications
{
"_profile": "https://api.apiture.com/schemas/accountApplications/applications/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "account applications",
"_links": {
"self": {
"href": "https://www.example.com/accountApplications/applications?start=10&limit=10"
},
"first": {
"href": "https://www.example.com/accountApplications/applications?start=0&limit=10"
},
"next": {
"href": "https://www.example.com/accountApplications/applications?start=20&limit=10"
},
"collection": {
"href": "https://www.example.com/accountApplications/applications"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "My Personal Checking",
"state": "running"
},
{
"_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
}
},
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"name": "6 Month CD",
"state": "approved"
}
]
}
}
Account Application Collection (Version v1.0.0
)
Collection of account applications. The items in the collection are ordered in the _embedded
object with name items
. The top-level _links
object may contain pagination links: self
, next
, prev
, first
, last
, collection
.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object Embedded resources. |
» items | [summaryApplication] An array containing a page of account application items. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
count | integer The number of items in the collection. This value is optional and my be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
start | integer The start index of this page of items. |
limit | integer The maximum number of items per page. |
name | string The name of the collection. |
summaryContact
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
}
Contact (Version v1.0.0
)
Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this contact resource. This is an immutable opaque string. |
firstName | string The contact's first name (or given name) |
middleName | string The contact's middle name |
lastName | string The contact's last name (or surname) |
preferredName | string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName .
|
identification | [object] A collection of official identifying information associated with the contact. This currently only supports government tax ID. |
» value | string (required) The value of this form of identification (the tax ID as a string, for example) |
» type | string (required) The type of this form of identification. Supported types include taxId and passportNumber.
|
» expiration | string(date) The date when the form of identification expires. |
addresses | [address] An array of postal mailing addresses for this contact. |
yearsAtAddress | string The contact's years at current home address |
mailingDifferentAddress | boolean The contact is handling a different address for mailing |
phones | [object] A collection of phone numbers associated with the contact. |
» type | string The type of phone number this represents.
|
» number | string The phone number, as a string. |
emailAddresses | [typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email. |
kycAnswers | object An object that contains the answers to kyc questions. These will be toggle-able and configurable in the future. |
birthdate | string(date) The contact's birth date in YYYY-MM-DD format.
|
citizenship | [object] The contact's citizenship or nationality status. |
» countryCode | string (required) The ISO 3166-1 country code for the contact's citizenship. minLength: 2
maxLength: 2
|
» state | string (required) The contact's citizenship status (values TBD).
|
occupation | string |
state | string The state of this contact.
|
identityVerificationStatus | string The identity verification status for this contact. This field is read-only and is derived from the results of any identity verification processes executed against the PII contained in this record. read-only
|
address
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
Address (Version v1.0.0
)
A postal address.
Properties
Name | Description |
---|---|
type | string
|
label | string A text label, suitable for presentation to the end user. This is also used if type is other .
|
addressLine1 | string The first street address line of the address, normally a house number and street name. |
addressLine2 | string The optional second street address line of the address. |
city | string The name of the city or municipality. |
regionCode | string The mailing address region code, such as state in the US, or a province in Canada. |
postalCode | string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. |
countryCode | string The ISO 3166-1 country code. minLength: 2
maxLength: 2
|
contactVerification
{
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
}
Contact Verification (Version v1.0.0
)
Identity verification results for a Contact (a person).
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
verifications | [any] |
» _links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» state | string
|
» verifiedAt | string(date-time) The date-time when the verification occurred, in RFC 3339 format ( YYYY-MM-DDThh:mm:ss.sssZ )
|
acknowledgment
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
Acknowledgment (Version v1.0.0
)
A document which the user has read and accepted/acknowledged.
Properties
Name | Description |
---|---|
documentUri | string The URI of the document that the user viewed. |
locale | string Optional locale of user. This is in HTTP Accept-Language format such as "en_US" or "en_MX" .
|
accepted | boolean A boolean value that indicates whether or not the user has accepted the document. |
acceptedAt | string(date-time) A time stamp indicating the date and time when the user accepted the document. This is an RFC 3339 formatted date time string. |
typedEmailAddress
{
"value": "JohnBankCustomer@example.com",
"type": "unknown"
}
Email Address (Version v1.0.0
)
An email address and the email address type.
Properties
Name | Description |
---|---|
value | string(email) The email address, such as JohnBankCustomer@example.com
minLength: 8
maxLength: 120
|
type | string The kind of email address this is.
|
money
{
"value": "3456.78",
"currency": "USD"
}
Money (Version v1.0.0
)
An amount of money in a specific currency.
Properties
Name | Description |
---|---|
value | string The net monetary value. A negative amount denotes a debit; a positive amount a credit. The numeric value is represented as a string so that it can be exact with no loss of precision. |
currency | string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3
maxLength: 3
|
applicant
{
"username": "string",
"contact": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/summaryContact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"identification": [
{
"value": "111-11-1111",
"type": "taxId"
}
],
"emailAddresses": [
{
"value": "api@apiture.com",
"type": "personal"
},
{
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"type": "home",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"status": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "N/A",
"familyOfPoliticalFigure": false,
"familyOfPoliticalFigureCountry": "N/A"
},
"state": "active",
"_links": {
"self": {
"href": "https://www.example.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"identityVerificationStatus": "verified"
},
"role": {
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
},
"verification": {
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2019-01-12T10:19:41Z"
}
]
},
"approvals": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
],
"acknowledgments": [
{
"documentUri": "https://www.example.com/vault/documents/7e27f43e-8b14-4f71-8065-57f364347aab",
"locale": "en_US",
"accepted": true,
"acceptedAt": "2019-11-14T07:45:52.375Z"
}
],
"consents": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
],
"fraudReport": {
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
},
"verified": true,
"verificationToken": "string"
}
Applicant (Version v1.0.0
)
An applicant for a new account.
Properties
Name | Description |
---|---|
username | string The unique username for the user. If omitted on a request, this field will be set for the primary applicant, based on the username of the authenticated user that creates the application. For co-owners and beneficial-owners this field is optional. |
contact | summaryContact A Contact object representing an individual user. |
role | role The role the user has on the account. This is a Role resource from the Associations API; it must be a bank account role. The default is determined by the number of applicants and the type of account (personal vs. business). |
verification | contactVerification The verification status of the user or contact. |
approvals | [approval] Any approvals associated with this applicant. |
acknowledgments | [acknowledgment] An array of documents which the the applicant has accepted, such as terms of use, electronic consent.
|
consents | [consent] An array of documents (such as terms and conditions, electronic consent) and the user's consent or agreement of the terms of those documents. The service configuration determines which consents are required for enrollment or account applications and sets this array on construction. |
fraudReport | fraudRiskReport The fraud risk report for the applicant. |
verified | boolean true if and only if the applicant has been verified.
read-only
|
verificationToken | string A secure token that contains identity verification data about a given contact including their verified status. The verified property in this applicant schema is derived from the Boolean status embedded in this token. The data contained in this token is derived from the results of any identity verification service operations previously performed on the contact. read-only
|
role
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"_id": "string",
"name": "owner",
"label": "Primary User",
"description": "string",
"createdAt": "2019-11-25T16:08:24Z"
}
Role (Version v1.0.0
)
A role that a user or contact holds relative to an account, such as Primary User_, Authorized Signer, _Power of Attorney.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this role resource. This is an immutable opaque string. |
name | string The name of this role, for identification purposes, such as owner , beneficiary , authorizedSigner . Some roles have well-known uses in the platform.
minLength: 1
maxLength: 128
|
label | string The text label for this role, for use in human presentation. This field may be localized. minLength: 1
maxLength: 128
|
description | string A fuller description of this role. This field may be localized. minLength: 1
maxLength: 4096
|
createdAt | string(date-time) The date-time when the role was created. This is in RFC 3339 format, UTC. This is derived and immutable. read-only
|
requiredDocument
{
"label": "string",
"type": "governmentId",
"productTarget": "business",
"documentUri": "string",
"category": "driversLicense",
"requireIfVerified": true
}
Required Document (Version v1.0.0
)
An document which is required from the applicant. If a templateUri
is provided, the applicant must download the document from the templateUri
and return it completed.
Properties
Name | Description |
---|---|
label | string (required) User friendly label of the document. |
type | string (required) The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a processedCheckImage , mobileCheckDepositImageFront , etc.). This type corresponds to the same type in the Vault API.
|
productTarget | string (required) The target of the relevant product, either business or personal . Note that business is synonymous with organizations in Apiture APIs.
|
documentUri | string A URI pointing to a form document that the applicant is required to download, fill out, optionally scan, then upload (as a new document) to satisfy this document requirement. The form document must reside in the document storage system. This is the URI of a shared document in the Vault API. |
category | string (required) Required document category, within the enum of options. Required for compliance to categorize PII documents.
|
requireIfVerified | boolean (required) Whether to require this document even if the associated applicant or business has passed verification. If true , this document will always be required.
|
document
{
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
}
Document (Version v1.0.0
)
Properties of a target document.
Properties
Name | Description |
---|---|
uri | string(url) (required) The URI of the target document that the user is consenting to. If the document is revised, this consent is marked as stale . (Note: This need not be a document in the Apiture vault.)
|
contentType | any (required) The media type for the document. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8. |
revisionId | string The revision identifier of the document revision the user consented to. If the content management system in which the document is stored does not define revision identifiers or tags, this may be omitted and will default to the revision time stamp. |
revisedAt | string(date-time) (required) The time stamp when the target document was last revised (modified), in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ).
|
productType
{
"_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
"_profile": "https://api.apiture.com/schemas/products/productType/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
},
"apiture:parent": {
"href": "https://www.example.com/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
}
},
"_embedded": {
"parent": {
"_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
"_profile": "https://api.apiture.com/schemas/products/productType/v1.0.0/profile.json",
"name": "Demand Deposit",
"label": "Demand Deposit",
"description": "A demand deposit checking account.",
"state": "active",
"subtype": false,
"subtypeCount": 1,
"_links": {
"self": {
"href": "https://www.example.com/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
}
}
}
},
"name": "Demand Deposit with interest",
"label": "Demand Deposit with Interest",
"description": "A demand deposit checking account with interest.",
"state": "active",
"subtype": true,
"subtypeCount": 0
}
Product Type (Version v1.0.0
)
Representation of a product type resource. The response may include links to related resources, in addition to the normal self
link:
apiture:parent
If this type is a subtype, this link will be present; it links to the parent type.apiture:children
If this type has subtypes, this link will be present; it links to the collection of direct subtypes of this type.apiture:products
is a link to a filtered collection of products which use this product type.apiture:activate
usePOST
to this link'shref
to activate ths current product type. This link only exists if the product type may be activated.apiture:deactivate
usePOST
to this link'shref
to deactivate ths current product type. This link only exists if the product type may be deactivated.apiture:remove
usePOST
to this link'shref
to remove ths current product type. This link only exists if the product type may be removed. Additionally, if the type is a subtype, the_embedded
resource will contain the parent type.
Properties
Name | Description |
---|---|
state | string
|
name | string The name of this product type. minLength: 1
maxLength: 128
|
label | string The text label for this product type. This field may be localized. minLength: 1
maxLength: 128
|
description | string(markdown) A fuller description of this product type. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text. minLength: 1
maxLength: 4096
|
subtype | boolean Indicates if this is a subtype. This is a derived, immutable property, based on whether the product type was created with a link to a parent type. See also the apiture:parent link on the productSubtype schema.
|
subtypeCount | number(integer) 0 if this type does not have subtypes; otherwise this holds the indicated number of direct subtypes. This is a derived, immutable property. See also the apiture:children link on the productSubtype schema.
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object Embedded resources for this product type. This may contain the parent type, if any. _embedded may not appear if there are no embedded resources. |
» parent | productType In subtypes, this is the parent type. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this product type resource. This is an opaque string. |
attributes | object An optional map of name/value pairs which provide additional metadata about the product type. |
createdAt | string(date-time) The date-time when this product type was created. This value is derived and immutable. |
summaryApproval
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Approval Summary (Version v1.0.0
)
Summary representation of an approval resource in approvals collections. This representation normally does not contain any _embedded
objects. If needed, call the GET
operation on the item's self
link to get _embedded
objects.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
label | string The approval's common name. If omitted on create request, this will default to the label of the Approval Type. |
description | string The approval's description. If omitted on create request, this will default to the description of the Approval Type. |
state | string The approval's state.
This is an immutable and derived property. It's value can only be changed by using the corresponding
|
done | boolean Inferred done flag. 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 .
|
typeName | string The name of the Approval Type. This field is immutable and derived from the name of the Approval Type. |
reviewedBy | string The id of the User that reviewed the approval. |
reviewedAt | string(date-time) The date-time when the approval was reviewed. |
_id | string The unique identifier for this approval resource. This is an immutable opaque string. |
approval
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
"createdAt": "2019-04-17T10:04:46.375Z",
"updatedAt": "2019-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:approvalType": {
"href": "https://www.example.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
},
"apiture:target": {
"href": "https://www.example.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
},
"apiture:approve": {
"href": "https://www.example.com/approvals/approvedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:reject": {
"href": "https://www.example.com/approvals/rejectedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:return": {
"href": "https://www.example.com/approvals/returnedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:waive": {
"href": "https://www.example.com/approvals/waivedApprovals?approval=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {
"approvalType": {
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "governmentId",
"label": "Government Issued ID",
"description": "A document that identifies a user"
}
}
}
Approval (Version 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 target of the approval is in the link named apiture:target
; see the Create Approval schema and createApproval
operation. Links on an approval convey which state transitions are available. These links are:
apiture:approve
-- mark the review request as approvedapiture:reject
-- to reject the approval requestapiture:waive
-- to waive the approval requirements. For example, rather than requiring a specific identity verification document to be approved, waiving the requirement means the document does not have to be provided.apiture:return
-- to return the request so the client can update the request or resource, then resubmit the request for approvalapiture:submit
-- to submit a new request for approval, or resubmit a request after it has been returnedapiture:cancel
-- to cancel the request for review/approval
The client should use POST
to invoke these operations, using the href
on the named link object. No request body is used on these operations. The absence of a link indicates that the particular state transition is not available at that time or that the caller is not authorized to make the change. For example, a user may lack permissions to approve a wire transfer they submitted.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object Embedded objects of this approval instance. |
» approvalType | summaryApprovalType The type of this approval. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
label | string The approval's common name. If omitted on create request, this will default to the label of the Approval Type. |
description | string The approval's description. If omitted on create request, this will default to the description of the Approval Type. |
state | string The approval's state.
This is an immutable and derived property. It's value can only be changed by using the corresponding
|
done | boolean Inferred done flag. 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 .
|
typeName | string The name of the Approval Type. This field is immutable and derived from the name of the Approval Type. |
reviewedBy | string The id of the User that reviewed the approval. |
reviewedAt | string(date-time) The date-time when the approval was reviewed. |
_id | string The unique identifier for this approval resource. This is an immutable opaque string. |
attributes | object An optional map of name/value pairs which provide additional metadata about the approval. |
createdAt | string(date-time) The RFC 3339 UTC formatted date-time when the approval was created. |
updatedAt | string(date-time) The RFC 3339 date-time when the approval was updated. |
verificationReport
{
"state": "failed",
"accountRiskFactors": [
{
"riskCode": 101,
"description": "Account owner first name does not match"
},
{
"riskCode": 102,
"description": "Account owner last name does not match"
},
{
"riskCode": 103,
"description": "Account owner zip code does not match"
}
]
}
Verification Report (Version v1.0.0
)
A verification report is an additional layer of validation that can be run against an instant verification resource. It uses available account aggregation data to generate a pass/fail result based on configured risk factors.
Properties
Name | Description |
---|---|
state | string The state of a verification report. passed indicates that the verification does not contain any risk factors based upon the user and account information, failed indicates that the verification contains one or more risk factors.
|
accountRiskFactors | [riskFactor] [A risk factor indicates a mismatch between user data and available account data.] |
riskFactor
{
"riskCode": "string",
"description": "string",
"attributes": {
"value": "string",
"expected": [
"string"
]
}
}
Risk Factor (Version v1.0.0
)
A risk factor indicates a mismatch between user data and available account data.
Properties
Name | Description |
---|---|
riskCode | string The risk factor risk code |
description | string The risk code description |
attributes | riskFactorAttributes Details of the data used to determine a risk factor |
riskFactorAttributes
{
"value": "string",
"expected": [
"string"
]
}
Risk Factor Attributes (Version v1.0.0
)
Details of the data used to determine a risk factor
Properties
Name | Description |
---|---|
value | string Supplied value for risk factor analysis |
expected | [string] Known values referenced for risk factor analysis |
fraudRiskReport
{
"_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
},
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
"type": "fraudRiskReport",
"inputs": {
"identity": {
"_profile": "https://api.apiture.com/schemas/identity/identity/v1.0.0/profile.json",
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
},
"outputs": {
"fraudRiskCategories": [
{
"type": "personalInfoDoesNotMatch",
"description": "The retrieved identity does not match the provided PII."
},
{
"type": "addressIsHighRisk",
"description": "The provided address is considered high-risk"
},
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
},
{
"type": "identityOnGovernmentWatchlist",
"description": "The provided identity is located on one or more watch lists"
},
{
"type": "ipRestricted",
"description": "The provided IP address is restricted"
},
{
"type": "emailRestricted",
"description": "The provided email address is restricted"
},
{
"type": "nonStandardTaxId",
"description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
},
{
"type": "ageRestricted",
"description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
}
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o"
}
}
Fraud-risk Report (Version v1.0.0
)
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
type | string
|
_id | string A unique identifier for this resource instance. This is is an opaque string. |
createdAt | string(date-time) The date-time when the resource was created. |
expiresAt | string(date-time) The date-time when the resource expires. |
inputs | fraudRiskReportInputs The inputs of a fraud-risk report. Used for workflow |
outputs | fraudRiskReportOutputs The outputs of a fraud-risk report. Used for workflow |
fraudRiskCategory
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
}
Fraud-risk Category (Version v1.0.0
)
Representation of a fraud-risk category
Properties
Name | Description |
---|---|
type | fraudRiskCategoryType Represents the possible types of fraud-risk |
description | string The description of the fraud. |
fraudRiskCategoryType
"ipRestricted"
Fraud Risk Category Type (Version v1.0.0
)
Represents the possible types of fraud-risk
Type: string
Enumerated values: ipRestricted
identityOnGovernmentWatchlist
identityOnAlertList
addressIsPOBoxOrNonApproved
addressIsHighRisk
ageRestricted
nonStandardTaxId
personalInfoDoesNotMatch
emailRestricted
fraudRiskReportOutputs
{
"token": "string",
"fraudRiskCategories": [
{
"type": "addressIsPOBoxOrNonApproved",
"description": "The provided address is a PO Box or other non-approved address"
}
]
}
Fraud-risk Report Outputs (Version v1.0.0
)
The outputs of a fraud-risk report. Used for workflow
Properties
Name | Description |
---|---|
token | string An opaque string that conveys the state of the contact's identity verification. |
fraudRiskCategories | [fraudRiskCategory] [Representation of a fraud-risk category] |
fraudRiskReportInputs
{
"identity": {
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
}
Fraud-risk Report Inputs (Version v1.0.0
)
The inputs of a fraud-risk report. Used for workflow
Properties
Name | Description |
---|---|
identity | identity Information that describes the identity |
inputs
{}
Inputs (Version v1.0.0
)
Base model schema for identity verification operations inputs
Properties
outputs
{
"token": "string"
}
Outputs (Version v1.0.0
)
Base model schema for identity verification operations outputs
Properties
Name | Description |
---|---|
token | string An opaque string that conveys the state of the contact's identity verification. |
verificationToken
{
"token": "string"
}
Verification Token (Version v1.0.0
)
The token used to validate and track a contact for identity verification purposes.
Properties
Name | Description |
---|---|
token | string An opaque string that conveys the state of the contact's identity verification. |
identity
{
"taxId": "555-55-5555",
"firstName": "John",
"lastName": "Smith",
"address1": "1741 Tiburon Dr",
"city": "Wilmington",
"region": "NC",
"postalCode": "28403",
"phone": "555-555-5555",
"birthdate": "1940-10-15",
"email": "api@apiture.com",
"ipAddress": "127.0.0.1"
}
Identity (Version v1.0.0
)
Information that describes the identity
Properties
Name | Description |
---|---|
taxId | string (required) The identity's tax or government ID minLength: 1
maxLength: 128
|
firstName | string (required) The identity's first name. minLength: 1
maxLength: 128
|
lastName | string (required) The identity's last name. minLength: 1
maxLength: 128
|
address1 | string (required) Line 1 of the identity's street address. minLength: 1
maxLength: 512
|
address2 | string Line 2 of the identity's street address. minLength: 1
maxLength: 512
|
city | string (required) The identity's city. minLength: 1
maxLength: 64
|
region | string (required) The identity's region. minLength: 1
maxLength: 128
|
postalCode | string (required) The identity's postal code. minLength: 1
maxLength: 32
|
phone | string (required) The identity's phone. minLength: 1
maxLength: 32
|
birthdate | string(date) (required) The identity's birth date in yyyy-mm-dd format.
minLength: 10
maxLength: 10
pattern: ^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))$
|
email | string(email) The identity's email address maxLength: 256
|
ipAddress | string(ipv4) The identity's IP address |
identityVerification
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"type": "fraudRiskReport",
"_id": "string",
"createdAt": "2019-11-25T16:08:24Z",
"expiresAt": "2019-11-25T16:08:24Z"
}
Identity Verification Resource (Version v1.0.0
)
The core representation of an identity verification resource
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
type | string
|
_id | string A unique identifier for this resource instance. This is is an opaque string. |
createdAt | string(date-time) The date-time when the resource was created. |
expiresAt | string(date-time) The date-time when the resource expires. |
identityVerificationType
{
"_links": {
"apiture:contact": {
"href": "/contacts/contacts/6da5ccc7-727a-4256-bdd4-74023ae349c3"
}
},
"verifications": [
{
"type": "fraudRiskReport",
"_links": {
"self": {
"href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
}
},
"state": "passed",
"verifiedAt": "2018-01-12T10:15:17Z"
},
{
"type": "quiz",
"_links": {
"self": {
"href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
}
},
"state": "passed",
"verifiedAt": "2018-01-12T10:19:41Z"
}
]
}
Identity Verification Type (Version v1.0.0
)
Represents the possible types of identity verification
Properties
Name | Description |
---|---|
type | string
|
businessVerifications
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"businessVerifications": [
{
"state": "passed",
"completedAt": "2019-11-25T16:08:24Z",
"type": "verificationReport",
"_id": "string",
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
}
}
]
}
Business Verifications (Version v1.0.0
)
Representation of the verification results that were previously generated by this service via the POST /businessVerifications
. The result contains a link to apiture:organization
if an apiture:organization
link was passed on the request to create the report.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
businessVerifications | [businessVerification] An array of business verification resources |
businessVerification
{
"state": "passed",
"completedAt": "2019-11-25T16:08:24Z",
"type": "verificationReport",
"_id": "string",
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
}
}
Business Verification Report (Version v1.0.0
)
The verification report contains analysis of the business data and includes the state of the verification.
Properties
Name | Description |
---|---|
state | string The state of a verification report. passed indicates that the Business was successfully verified based upon the supplied information, failed indicates it was not.
|
completedAt | string(date-time) An ISO 8601 UTC time stamp indicating when the verification report was created. |
type | string The identity method type. Possible values are verificationReport or administratorApproval .
|
_id | string This business verification's unique id |
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
organization
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"_embedded": {}
}
Organization (Version v1.0.0
)
Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization. An organization may have the following links in the _links
object:
apiture:activate
- Activate a new, pending organizationapiture:deactivate
- Deactivate an organization (if it is active)apiture:remove
- Remove an inactive organization
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
name | string The organization's official full name |
label | string The organization's common name. |
type | string Indicates what type of organization this resource represents. NOTE: This may move to a mutable
|
subtype | string A refinement of the type . NOTE: This may move to a mutable
|
identification | [object] A collection of official identifying information associated with the contact. This currently only supports government tax ID. |
» value | string (required) The value of this form of identification (the tax ID as a string, for example) |
» type | string (required) The type of this form of identification. taxId is the only supported type at this time.
|
» expiration | string(date) The date when the form of identification expires. |
addresses | [address] An array of postal mailing addresses for this organization. |
phones | [object] A collection of phone numbers associated with the organization. |
» type | string The type of phone number this represents.
|
» number | string The phone number, as a string. |
emailAddresses | [typedEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
state | string The state of this organization.
|
tradeName | string The trade name of the organization. |
establishedDate | string(date) The date the organization was established. |
governmentOwned | boolean Indicates whether the organization is a government-owned entity. |
publiclyHeld | boolean Indicates whether the organization is publicly held. |
smallBusiness | boolean Indicates whether the organization is classified as a small business |
taxExempt | boolean Indicates whether the organization is the tax-exempt. |
employeeCountLowerBound | number The lower bound of persons employed. minimum: 1
|
employeeCountUpperBound | number The upper bound of persons employed. maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | object An object containing answers to organization specific regulatory questions. |
currency | string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3
maxLength: 3
|
estimatedAnnualRevenue | string Dollar amount of estimated revenue. |
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | object Indicates the estimated monthly amounts for wires, mobile deposits and ACH |
» sentWire | string Indicates the estimated monthly minimum wires amount sent. |
» receivedWire | string Indicates the estimated monthly minimum wires amount received. |
» mobileCheckDeposit | string Indicates the estimated monthly minimum amount to deposit. |
» receivedAch | string Indicates the estimated monthly total amount to receive by ACH. |
» sentAch | string Indicates the estimated monthly total amount to send by ACH. |
_id | string The unique identifier for this organization resource. This is an immutable opaque string. |
attributes | object An optional map of name/value pairs which provide additional metadata about the organization. |
createdAt | string(date-time) The date-time when the organization was created. |
updatedAt | string(date-time) The date-time when the organization was updated |
updateOrganization
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}
Update Organization (Version v1.0.0
)
Representation used to update or patch an organization.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
name | string The organization's official full name |
label | string The organization's common name. |
type | string Indicates what type of organization this resource represents. NOTE: This may move to a mutable
|
subtype | string A refinement of the type . NOTE: This may move to a mutable
|
identification | [object] A collection of official identifying information associated with the contact. This currently only supports government tax ID. |
» value | string (required) The value of this form of identification (the tax ID as a string, for example) |
» type | string (required) The type of this form of identification. taxId is the only supported type at this time.
|
» expiration | string(date) The date when the form of identification expires. |
addresses | [address] An array of postal mailing addresses for this organization. |
phones | [object] A collection of phone numbers associated with the organization. |
» type | string The type of phone number this represents.
|
» number | string The phone number, as a string. |
emailAddresses | [typedEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
state | string The state of this organization.
|
tradeName | string The trade name of the organization. |
establishedDate | string(date) The date the organization was established. |
governmentOwned | boolean Indicates whether the organization is a government-owned entity. |
publiclyHeld | boolean Indicates whether the organization is publicly held. |
smallBusiness | boolean Indicates whether the organization is classified as a small business |
taxExempt | boolean Indicates whether the organization is the tax-exempt. |
employeeCountLowerBound | number The lower bound of persons employed. minimum: 1
|
employeeCountUpperBound | number The upper bound of persons employed. maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | object An object containing answers to organization specific regulatory questions. |
currency | string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3
maxLength: 3
|
estimatedAnnualRevenue | string Dollar amount of estimated revenue. |
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | object Indicates the estimated monthly amounts for wires, mobile deposits and ACH |
» sentWire | string Indicates the estimated monthly minimum wires amount sent. |
» receivedWire | string Indicates the estimated monthly minimum wires amount received. |
» mobileCheckDeposit | string Indicates the estimated monthly minimum amount to deposit. |
» receivedAch | string Indicates the estimated monthly total amount to receive by ACH. |
» sentAch | string Indicates the estimated monthly total amount to send by ACH. |
_id | string The unique identifier for this organization resource. This is an immutable opaque string. |
attributes | object An optional map of name/value pairs which provide additional metadata about the organization. |
summaryOrganization
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Organization Summary (Version v1.0.0
)
Summary representation of an organization resource in organizations collections. This representation normally does not contain any _embedded
objects. If needed, call the GET
operation on the item's self
link to get _embedded
objects.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
name | string The organization's official full name |
label | string The organization's common name. |
type | string Indicates what type of organization this resource represents. NOTE: This may move to a mutable
|
subtype | string A refinement of the type . NOTE: This may move to a mutable
|
identification | [object] A collection of official identifying information associated with the contact. This currently only supports government tax ID. |
» value | string (required) The value of this form of identification (the tax ID as a string, for example) |
» type | string (required) The type of this form of identification. taxId is the only supported type at this time.
|
» expiration | string(date) The date when the form of identification expires. |
addresses | [address] An array of postal mailing addresses for this organization. |
phones | [object] A collection of phone numbers associated with the organization. |
» type | string The type of phone number this represents.
|
» number | string The phone number, as a string. |
emailAddresses | [typedEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
state | string The state of this organization.
|
tradeName | string The trade name of the organization. |
establishedDate | string(date) The date the organization was established. |
governmentOwned | boolean Indicates whether the organization is a government-owned entity. |
publiclyHeld | boolean Indicates whether the organization is publicly held. |
smallBusiness | boolean Indicates whether the organization is classified as a small business |
taxExempt | boolean Indicates whether the organization is the tax-exempt. |
employeeCountLowerBound | number The lower bound of persons employed. minimum: 1
|
employeeCountUpperBound | number The upper bound of persons employed. maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | object An object containing answers to organization specific regulatory questions. |
currency | string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3
maxLength: 3
|
estimatedAnnualRevenue | string Dollar amount of estimated revenue. |
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | object Indicates the estimated monthly amounts for wires, mobile deposits and ACH |
» sentWire | string Indicates the estimated monthly minimum wires amount sent. |
» receivedWire | string Indicates the estimated monthly minimum wires amount received. |
» mobileCheckDeposit | string Indicates the estimated monthly minimum amount to deposit. |
» receivedAch | string Indicates the estimated monthly total amount to receive by ACH. |
» sentAch | string Indicates the estimated monthly total amount to send by ACH. |
_id | string The unique identifier for this organization resource. This is an immutable opaque string. |
organizationFields
{
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"value": "john@smithsauto.com",
"type": "work"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555"
},
{
"type": "mobile",
"number": "(999) 555-5555"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"state": "active",
"currency": "USD",
"estimatedAnnualRevenue": "125000.51",
"estimatedMonthlyAmounts": {
"sentWire": "20000.00",
"receivedWire": "30000.00",
"mobileCheckDeposit": "250000.00",
"receivedAch": "40000.00",
"sentAch": "35000.00"
}
}
]
}
Organization Fields (Version v1.0.0
)
Common fields of the organization resource used to build other model schemas.
Properties
Name | Description |
---|---|
name | string The organization's official full name |
label | string The organization's common name. |
type | string Indicates what type of organization this resource represents. NOTE: This may move to a mutable
|
subtype | string A refinement of the type . NOTE: This may move to a mutable
|
identification | [object] A collection of official identifying information associated with the contact. This currently only supports government tax ID. |
» value | string (required) The value of this form of identification (the tax ID as a string, for example) |
» type | string (required) The type of this form of identification. taxId is the only supported type at this time.
|
» expiration | string(date) The date when the form of identification expires. |
addresses | [address] An array of postal mailing addresses for this organization. |
phones | [object] A collection of phone numbers associated with the organization. |
» type | string The type of phone number this represents.
|
» number | string The phone number, as a string. |
emailAddresses | [typedEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
state | string The state of this organization.
|
tradeName | string The trade name of the organization. |
establishedDate | string(date) The date the organization was established. |
governmentOwned | boolean Indicates whether the organization is a government-owned entity. |
publiclyHeld | boolean Indicates whether the organization is publicly held. |
smallBusiness | boolean Indicates whether the organization is classified as a small business |
taxExempt | boolean Indicates whether the organization is the tax-exempt. |
employeeCountLowerBound | number The lower bound of persons employed. minimum: 1
|
employeeCountUpperBound | number The upper bound of persons employed. maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | object An object containing answers to organization specific regulatory questions. |
currency | string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3
maxLength: 3
|
estimatedAnnualRevenue | string Dollar amount of estimated revenue. |
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | object Indicates the estimated monthly amounts for wires, mobile deposits and ACH |
» sentWire | string Indicates the estimated monthly minimum wires amount sent. |
» receivedWire | string Indicates the estimated monthly minimum wires amount received. |
» mobileCheckDeposit | string Indicates the estimated monthly minimum amount to deposit. |
» receivedAch | string Indicates the estimated monthly total amount to receive by ACH. |
» sentAch | string Indicates the estimated monthly total amount to send by ACH. |
configuration
{
"_links": {
"self": {
"href": "/accountApplications/configurations/"
},
"apiture:groups": {
"href": "/accountApplications/configurations/groups"
}
}
}
Configuration (Version v1.0.0
)
Represents the configuration for the Applications API
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
configurationGroups
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroups/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "configurationGroups",
"_links": {
"self": {
"href": "/accountApplications/configurations/groups?start=10&limit=10"
},
"first": {
"href": "/accountApplications/configurations/groups?start=0&limit=10"
},
"next": {
"href": "/accountApplications/configurations/groups?start=20&limit=10"
},
"collection": {
"href": "/accountApplications/configurations/groups"
}
},
"_embedded": {
"items": [
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/configurations/groups/basic"
},
"apiture:configuration": {
"href": "/configurations"
}
},
"name": "basic",
"label": "Basic Settings",
"description": "The basic settings for the Applications API"
}
]
}
}
Configuration Group Collection (Version v1.0.0
)
Collection of configuration groups. The items in the collection are ordered in the _embedded
object with name items
. The top-level _links
object may contain pagination links (self
, next
, prev
, first
, last
, collection
).
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object |
» items | [configurationGroupSummary] An array containing a page of configuration group items. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
count | integer The number of items in the collection. This value is optional and my be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
start | integer The start index of this page of items. |
limit | integer The maximum number of items per page. |
name | string The name of the collection. |
configurationGroupSummary
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
},
"name": "applications",
"label": "Applications Configuration",
"description": "The configuration for the Applications API."
}
Configuration Group Summary (Version v1.0.0
)
A summary of the data contained within a configuration group resource
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
name | string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
|
label | string The text label for this resource, suitable for presentation to the client. minLength: 1
maxLength: 128
|
description | string The full description for this resource, suitable for presentation to the client. minLength: 1
maxLength: 4096
|
configurationGroup
{
"_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/configurations/groups/basic"
},
"apiture:configuration": {
"href": "/configurations"
}
},
"name": "basic",
"label": "Basic Settings",
"description": "The basic settings for the Applications API",
"schema": {
"type": "object",
"properties": {
"defaultPersonalWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for personal product types"
},
"defaultBusinessWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for business product types"
}
}
},
"values": {
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}
}
Configuration Group (Version v1.0.0
)
Represents a configuration group.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
name | string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
|
label | string The text label for this resource, suitable for presentation to the client. minLength: 1
maxLength: 128
|
description | string The full description for this resource, suitable for presentation to the client. minLength: 1
maxLength: 4096
|
schema | configurationSchema The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, - , _ following the pattern letter [letter | digit | '-' | '_']* This is implicitly a schema for type: object and contains the properties. The |
values | configurationValues The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema . Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values . (For example, multiple configurations may use the same schema that defines values a , b , and c , but each configuration may have their own unique values for a , b , and c which is separate from the schema.)
|
configurationSchema
{
"type": "object",
"properties": {
"defaultPersonalWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for personal product types"
},
"defaultBusinessWorkflowDefinitionUri": {
"type": "string",
"description": "The default workflow definition uri to use for business product types"
}
}
}
Configuration Schema (Version v1.0.0
)
The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, -
, following the pattern
letter [letter | digit | '-' | '
']* This is implicitly a schema for type: object
and contains the properties.
The values
in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.
Properties
configurationValues
{
"defaultPersonalWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/5311b7f6-8370-4b24-9050-9b030f432eb2",
"defaultBusinessWorkflowDefinitionUri": "https://api.apiture.com/workflow/workflowDefinitions/260d3dec-214e-4010-8448-898c4c07f1ae"
}
Configuration Values (Version v1.0.0
)
The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema
. Note: the schema
may also contain default
values which, if present, are used if a value is not set in the definition's values
. (For example, multiple configurations may use the same schema that defines values a
, b
, and c
, but each configuration may have their own unique values for a
, b
, and c
which is separate from the schema.)
Properties
attributes
{}
Attributes (Version v1.0.0
)
An optional map of name/value pairs which contains additional dynamic data about the resource.
Properties
errorResponse
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://api.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}
Error Response (Version v1.0.0
)
Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error
object contains the error details.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
root
{
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0",
"_profile": "http://localhost:8080/schemas/common/root/v1.0.0/profile.json",
"_links": {}
}
API Root (Version v1.0.0
)
A HAL response, with hypermedia _links
for the top-level resources and operations in API.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string This API's unique ID. |
name | string This API's name. |
apiVersion | string This API's version. |
accountNumbers
{
"masked": "*************3210",
"full": "9876543210"
}
Account Numbers (Version v1.0.0
)
Different representations of an account number.
Properties
Name | Description |
---|---|
masked | string A partial account number that does not contain all the digits of the full account number. This masked number appears in statements or in user experience presentation. It is sufficient for a user to differentiate this account from other accounts they hold, but is not sufficient for initiating transfers, etc. The first character is the mask character and is repeated; this does not indicate that the full account number is the same as the mask length. This value is derived and immutable. read-only
minLength: 8
maxLength: 32
|
full | string The full account number. This value only appears when ?unmasked=true is passed on the GET request. Not included in the summary representation of the account that is included in account collection responses. This value is derived and immutable.
read-only
minLength: 4
maxLength: 17
|
links
{
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
}
Links (Version v1.0.0
)
An optional map of links, mapping each link relation to a link object. This model defines the _links
object of HAL representations.
Properties
Name | Description |
---|---|
additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
consent
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisionId": "2019:1.02.0",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"state": "given",
"givenAt": "2019-07-23T13:27:34.375Z",
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:revoke": {
"href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:rescind": {
"href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Consent (Version v1.0.0
)
Representation of a consent resource. Users consent or acceptance of a policy or other document.
Properties
Name | Description |
---|---|
document | document Properties of the target document. |
type | string Describe what kind of consent this is. This value must be one of the type names in the /consentTypeNames resource.
|
contextUri | string(url) The URI of a resource that establishes the context in which the user's consent is requested for a specific document. For example, for consent of an account's terms and conditions, the context might be the banking product for that account. |
userId | string The user ID of the user who is requested to consent to a document. This is the _id of the User resource.
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this consent resource. This is an immutable opaque string. |
state | consentStates The state of this consent. read-only
|
givenAt | string(date-time) The time stamp when the user last consented to the document, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). This property is not set if state is pending .
read-only
|
requestRevokedAt | string(date-time) The time stamp when the user revoked consent, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). A revoked consent reflects a consent request that the user has previously given but has reversed. Revoking a consent sets the state back to pending and clears consentedAt .
read-only
|
requestRescindedAt | string(date-time) The time stamp when the consent request was rescinded by the requester, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). A rescinded consent reflects a consent request that the system or application has issued in the past but no longer requires. For example, if a user is removed as an authorized signer from an account and a consent is pending for that account's terms and conditions, the Accounts service may rescind that consent request. This property is set only if state is rescinded .
read-only
|
See the definition of the consent
schema in consents
API for definition of the links on this schema.
revisionEffectiveInterval
{
"effectiveStartAt": "2019-11-25T16:08:24Z",
"effectiveEndAt": "2019-11-25T16:08:24Z"
}
Revision Effective Time Interval (Version v1.0.0
)
Time interval when a resource revision was effective and in use. This schema is used when composing other schemas.
Properties
Name | Description |
---|---|
effectiveStartAt | string(date-time) The date-time when this revision was created and became effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ . This field is derived and immutable.
|
effectiveEndAt | string(date-time) The date-time when the another revision became effective and this revision ceased being effective. This is an RFC 3339 formatted date-time string YYYY-MM-DDThh:mm:ss.sssZ . This field is derived and immutable and is not present until the revision is no longer active.
|
link
{
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
Link (Version v1.0.0
)
Describes a hypermedia link within a _links
object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name
or hreflang
properties of HAL. Apiture links may include a method
property.
Properties
Name | Description |
---|---|
href | string(uri) (required) The URI or URI template for the resource/operation this link refers to. |
type | string The media type for the resource. |
templated | boolean If true, the link's href is a URI template. |
title | string An optional human-readable localized title for the link. |
deprecation | string(uri) If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation. |
profile | string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. |
error
{
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"message": "The value for deposit must be greater than 0.",
"statusCode": 422,
"type": "positiveNumberRequired",
"attributes": {
"value": -125.5
},
"remediation": "Provide a value which is greater than 0",
"occurredAt": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
Error (Version v1.0.0
)
Describes an error in an API request or in a service called via the API.
Properties
Name | Description |
---|---|
message | string (required) A localized message string describing the error condition. |
_id | string A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string. |
statusCode | integer The HTTP status code associate with this error. minimum: 100
maximum: 599
|
type | string An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode . For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet .
|
occurredAt | string(date-time) An RFC 3339 UTC time stamp indicating when the error occurred. |
attributes | attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type .
|
remediation | string An optional localized string which provides hints for how the user or client can resolve the error. |
errors | [error] An optional array of nested error objects. This property is not always present. |
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
_embedded | object Embedded objects. An error object may contain nested errors. For example, an API which validates its request body may find multiple errors in the request, which are returned with an error response with nested errors. These are held in an items array of errorResponse objects. _embedded or _embedded.items may not exist if the error does not have nested errors. This property is deprecated; use see error.errors instead.
|
» items | [errorResponse] An array of error objects. |
summaryConsent
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/consents/summaryConsent/v1.0.0/profile.json",
"document": {
"uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
"contentType": "application/pdf",
"revisedAt": "2019-07-23T08:26:45.375Z"
},
"type": "termsAndConditions",
"userId": "5a5e834c-a7bd-401c",
"state": "pending",
"contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
"_links": {
"self": {
"href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Consent Summary (Version v1.0.0
)
Summary representation of a consent resource in consents collections. This representation normally does not contain any _embedded
objects. If needed, call the GET
operation on the item's self
link to get _embedded
objects.
Properties
Name | Description |
---|---|
document | document Properties of the target document. |
type | string Describe what kind of consent this is. This value must be one of the type names in the /consentTypeNames resource.
|
contextUri | string(url) The URI of a resource that establishes the context in which the user's consent is requested for a specific document. For example, for consent of an account's terms and conditions, the context might be the banking product for that account. |
userId | string The user ID of the user who is requested to consent to a document. This is the _id of the User resource.
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
|
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. |
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. |
_id | string The unique identifier for this consent resource. This is an immutable opaque string. |
state | consentStates The state of this consent. read-only
|
givenAt | string(date-time) The time stamp when the user last consented to the document, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). This property is not set if state is pending .
read-only
|
requestRevokedAt | string(date-time) The time stamp when the user revoked consent, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). A revoked consent reflects a consent request that the user has previously given but has reversed. Revoking a consent sets the state back to pending and clears consentedAt .
read-only
|
requestRescindedAt | string(date-time) The time stamp when the consent request was rescinded by the requester, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). A rescinded consent reflects a consent request that the system or application has issued in the past but no longer requires. For example, if a user is removed as an authorized signer from an account and a consent is pending for that account's terms and conditions, the Accounts service may rescind that consent request. This property is set only if state is rescinded .
read-only
|
consentFields
{
"document": {
"uri": "string",
"contentType": "application/pdf",
"revisionId": "2019:1.2.0",
"revisedAt": "2019-11-25T16:08:24Z"
},
"type": "string",
"contextUri": "string",
"userId": "string"
}
Consent Fields (Version v1.0.0
)
Common fields of the consent resource used to build other model schemas.
Properties
Name | Description |
---|---|
document | document Properties of the target document. |
type | string Describe what kind of consent this is. This value must be one of the type names in the /consentTypeNames resource.
|
contextUri | string(url) The URI of a resource that establishes the context in which the user's consent is requested for a specific document. For example, for consent of an account's terms and conditions, the context might be the banking product for that account. |
userId | string The user ID of the user who is requested to consent to a document. This is the _id of the User resource.
|
consentStates
"pending"
Consent States (Version v1.0.0
)
The state of a consent resource.
Type: string
Enumerated values: pending
given
stale
rescinded
revoked