Account Applications v0.17.8

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)
• consents the applicant has given (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.

Error Types

Error responses in this API may have one of the following `type` values.

accessForbidden

Description: The credentials supplied in the request are insufficient to grant access.

Remediation: Check the supplied credentials for validity.

applicationNotFound

Description: No applications were found for the specified applicationId.

Remediation: Check to make sure that the supplied applicationId corresponds to an apiture application resource.

invalidContactId

Description: No contact was found for the specified contactId.

Remediation: Check to make sure that the supplied contactId corresponds to an apiture contact resource.

preconditionFailed

Description: The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

Remediation: Resubmit the operation, supplying the value of the ETag and the most recent state of the resource.

preconditionRequired

Description: Precondition Required. The request did not include the required if-Match header.

Remediation: Resubmit with the operation, supplying the value of the ETag and the most recent state of the resource.

productNotFound

Description: No Products were found for the specified productId.

Remediation: Check to make sure that the supplied productId corresponds to an apiture product resource.

productNotSupplied

Description: A link to the product was not supplied for the account.

Remediation: Include a link to a valid apiture product in the _links object of your request.

internalError

Description: An unexpected internal server error occurred.

Remediation: Retry the operation again.

emptyRequestBody

Description: The supplied request body was empty.

Remediation: Check to make sure the body is included in your request.

malformedApplicationUri

Description: The supplied applicationUri was malformed.

Remediation: Check to make sure that the supplied applicationUri corresponds to an apiture application resource.

invalidGroupName

Description: No configurationGroup was found for the specified groupName.

Remediation: Check to make sure that the supplied groupName corresponds to an apiture transfer configuration group resource.

invalidValueName

Description: No configurationName was found for the specified valueName.

Remediation: Check to make sure that the supplied valueName corresponds to an apiture transfer configuration value resource.

invalidConfigurationGroup

Description: The request body did not conform to the schema for this configuration group.

Remediation: Check the schema for the configuration group and resubmit the operation.

invalidConfigurationValue

Description: The request body did not conform to the schema for this configuration group value.

Remediation: Check the schema for the configuration group value and resubmit the operation.

invalidApplicationState

Description: Actions on applications may only be performed if they are in one of the required states.

Remediation: Check the state of your application and the applicable allowed state transitions in the Applications API documentation.

The attributes object in the error may have the following properties:

Property	Type	Description
currentState	string	The current `state` of the the application. Example: `expired`
requestedState	string	The requested new `state` value in the request. Example: `approved`
requiredStates	array	The set of states the application must be in for the requested state change to be valid. Example: `running,blocked`

invalidApplicationApproval

Description: Application can only be approved when the workflow is completed and any approval records are approved.

Remediation: Check the state of the workflow and associated approval records.

The attributes object in the error may have the following properties:

Property	Type	Description
currentState	string	The current `state` of the the application. Example: `running`
workflowState	string	The current `state` of the workflow associated with the application. Example: `running`
approvalStates	array	The state of the approvals in an application Example: `approved,rejected`

unverifiedApplications

Description: Initial application is either in process or under review.

Remediation: Retry the operation when there are no other in process applications.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/accountApplications

Terms of service

Email: Apiture Web: Apiture

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 private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: 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 = /auth/oauth2/authorize
  • Token URL = /auth/oauth2/token

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. Default: 100
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 applications collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending matches only items whose state is pending; ?state=running|canceled matches 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 applications collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell will match only items whose name is Bartell; ?name=Bartell|kirsten will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/applications/v2.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

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. Default: 100
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.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/applications/v2.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

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. Default: 100
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.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/applications/v2.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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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)

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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)

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

Example responses

409 Response

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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.

Try It

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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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

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. Default: 100
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.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/enrollments/v2.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

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",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ]
}';
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",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ]
}

Parameters

Parameter	Description
body (body)	createEnrollment (required) The data necessary to create a new enrollment.

Try It

Example responses

201 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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.

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  }
}';
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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  }
}

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)

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  }
}';
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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "username": "string",
        "state": "active",
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        }
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "username": "string",
      "state": "active",
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      }
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  }
}

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)

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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.

Try It

Responses

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.

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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.

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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.

Try It

Example responses

200 Response

{
  "applicants": [
    {
      "username": "string",
      "contact": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Responses

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.

Try It

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.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.

Try It

Example responses

200 Response

{}

Responses

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

Try It

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "/configurations/configurations/"
    },
    "apiture:groups": {
      "href": "/configurations/configurations/groups"
    }
  }
}

Responses

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. Default: 100
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.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Responses

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.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": "17:30:00"
  }
}

Responses

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.

Try It

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

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.

Try It

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Responses

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 = '{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}';
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

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

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)

Try It

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

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 | '-' | '_']*

Try It

Example responses

200 Response

"string"

Responses

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.

Try It

Example responses

200 Response

"string"

Responses

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 (v2.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	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 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.
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.
attributes	attributes An optional map of name/value pairs which provide additional metadata about the application. If this object contain an accountAtributes object, the properties in that object are placed in the attributes of the new account that this application creates.
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.
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.
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	verifiedTransferAccount 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": "2018-12-13T11:01:41.375Z",
  "_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 (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	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 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: pending - Available to be started (POST to the apiture:start link to start it). This state is reserved for future use. running - Started and has not completed or been canceled. blocked - Started but is blocked; there are no available workflow tasks. canceled - Canceled prior to completion expired - Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired. rejected - Completed but was rejected after review approved - Completed and approved The value is updated by the various enrollment or application operations. read-only Enumerated values: pending running blocked canceled expired rejected approved
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.
attributes	attributes An optional map of name/value pairs which provide additional metadata about the application. If this object contain an accountAtributes object, the properties in that object are placed in the attributes of the new account that this application creates.
_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": "2018-12-13T11:01:41.375Z",
  "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"
      }
    }
  },
  "consents": [],
  "_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 (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

Response and request bodies 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	Product	GET
apiture:applicant	Applicant	GET
apiture:organization	Organization	GET
apiture:fundingAccount	Funding Account	GET
apiture:workflow	Workflow	GET
apiture:approval	Application Approval	GET

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.
_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: pending - Available to be started (POST to the apiture:start link to start it). This state is reserved for future use. running - Started and has not completed or been canceled. blocked - Started but is blocked; there are no available workflow tasks. canceled - Canceled prior to completion expired - Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired. rejected - Completed but was rejected after review approved - Completed and approved The value is updated by the various enrollment or application operations. read-only Enumerated values: pending running blocked canceled expired rejected approved
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.
attributes	attributes An optional map of name/value pairs which provide additional metadata about the application. If this object contain an accountAtributes object, the properties in that object are placed in the attributes of the new account that this application creates.
_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
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.
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.
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	verifiedTransferAccount 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	integer(int32) The number of visible workflow tasks which have been completed. read-only
runningTaskCount	integer(int32) The number of visible workflow tasks which are currently running. read-only
runningTaskNames	[string] The names of the tasks which are currently running in the application's workflow. read-only
pendingTaskCount	integer(int32) The number of visible workflow tasks which are still pending. read-only
blockedTaskCount	integer(int32) The number of visible workflow tasks which are blocked. read-only
canceledTaskCount	integer(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

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",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
            }
          },
          "name": "governmentId",
          "label": "Government Issued ID",
          "description": "A document that identifies a user"
        }
      }
    }
  ]
}

Create an Enrollment (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	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 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.
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.
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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Digital Banking User Enrollment Summary (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: pending - Available to be started (POST to the apiture:start link to start it). This state is reserved for future use. running - Started and has not completed or been canceled. blocked - Started but is blocked; there are no available workflow tasks. canceled - Canceled prior to completion expired - Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired. rejected - Completed but was rejected after review approved - Completed and approved The value is updated by the various enrollment or application operations. read-only Enumerated values: pending running blocked canceled expired rejected approved
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	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 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/contact/v1.0.0/profile.json",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "suffix": "MD",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "emailAddresses": [
          {
            "_id": "ea1",
            "value": "api@apiture.com",
            "type": "personal"
          },
          {
            "_id": "ek3",
            "value": "support@apiture.com",
            "type": "work"
          }
        ],
        "preferredEmailAddressId": "ea1",
        "phones": [
          {
            "_id": "pa1",
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "_id": "da6",
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "preferredPhoneId": "pa1",
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "resident",
        "occupation": "officeAndAdministrativeSupport",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "_id": "wa1",
            "type": "work",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "preferredMailingAddressId": "ha1",
        "identityVerification": {
          "provider": "IDology",
          "sessionId": "123456",
          "scoredAt": "2019-09-13T13:06:52.078Z",
          "score": "passed",
          "state": "verified"
        },
        "yearsAtAddress": 3,
        "mailingDifferentAddress": false,
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": false,
          "employmentStatus": "fullTime",
          "occupation": "officeAndAdministrativeSupport",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "N/A",
          "familyOfPoliticalFigure": false
        },
        "state": "active",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:deactivate": {
            "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      "user": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "addresses": [
          {
            "_id": "ha1",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
              }
            }
          }
        ],
        "preferredMailingAddressId": "stri",
        "emailAddresses": [
          {
            "_id": "pe1",
            "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
            "type": "personal",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "delete": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
              },
              "apiture:setAsPreferred": {
                "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
              }
            }
          }
        ],
        "preferredEmailAddressId": "stri",
        "phones": [
          {
            "_id": "hp1",
            "type": "home",
            "number": "555-555-5555"
          }
        ],
        "preferredPhoneId": "stri",
        "prefix": "string",
        "suffix": "string",
        "preferredName": "string",
        "identification": [
          {
            "type": "taxId",
            "value": "111-11-1111",
            "expiration": {}
          }
        ],
        "preferredContactMethod": "unknown",
        "birthdate": "2020-05-21",
        "citizenship": [
          {
            "countryCode": "US",
            "state": "citizen"
          }
        ],
        "residencyStatus": "unknown",
        "occupation": "unknown",
        "otherOccupation": "string",
        "yearsAtAddress": "unknown",
        "kycAnswers": {
          "citizen": true,
          "permanentResident": true,
          "w9Withholdings": true,
          "employmentStatus": "unknown",
          "foreignPoliticalFigure": false,
          "countryPoliticalFigure": "string",
          "familyOfPoliticalFigure": true,
          "foreignPoliticalFigureCountry": "st",
          "foreignPoliticalFigureAssociation": "unknown"
        },
        "identityVerification": {
          "provider": "string",
          "sessionId": "string",
          "scoredAt": "2019-09-13T06:11:01.375Z",
          "score": "passed",
          "state": "verified"
        },
        "username": "string",
        "state": "active",
        "phoneNumbers": [
          {
            "_id": "hp1",
            "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
            "type": "home",
            "number": "555-555-5555",
            "state": "approved",
            "_links": {
              "self": {
                "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
              }
            }
          }
        ],
        "_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": "2eae46e1575c0a7b0115a4b3",
          "message": "Descriptive error message...",
          "statusCode": 422,
          "type": "errorType1",
          "remediation": "Remediation string...",
          "occurredAt": "2018-01-25T05:50:52.375Z",
          "errors": [
            {
              "_id": "ccdbe2c5c938a230667b3827",
              "message": "An optional embedded error"
            },
            {
              "_id": "dbe9088dcfe2460f229338a3",
              "message": "Another optional embedded error"
            }
          ],
          "_links": {
            "describedby": {
              "href": "https://developer.apiture.com/errors/errorType1"
            }
          }
        },
        "_id": "string",
        "customerId": "00047294723672"
      },
      "role": {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "name": "primaryUser",
        "label": "Primary User",
        "createdAt": "2018-02-01T13:07:01.375Z",
        "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
      },
      "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",
            "createdAt": "2018-01-12T10:15:17Z"
          },
          {
            "type": "quiz",
            "_links": {
              "self": {
                "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
              }
            },
            "state": "passed",
            "createdAt": "2018-01-12T10:19:41Z"
          }
        ]
      },
      "approvals": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
          "reason": "Invalid U.S. Address",
          "createdAt": "2018-04-17T10:04:46.375Z",
          "updatedAt": "2018-04-17T10:12:58.375Z",
          "_links": {
            "self": {
              "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:approvalType": {
              "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
            },
            "apiture:target": {
              "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
            }
          },
          "_embedded": {
            "approvalType": {
              "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
              "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
              "_links": {
                "self": {
                  "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
                }
              },
              "name": "governmentId",
              "label": "Government Issued ID",
              "description": "A document that identifies a user"
            }
          }
        }
      ],
      "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": "productTermsAndConditions",
          "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/v2.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/v2.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": {
          "state": "passedWithRiskFactors",
          "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 watchlists"
            },
            {
              "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": "http://example.com",
      "contentType": "application/pdf",
      "revisionId": "2019:1.2.0",
      "revisedAt": "2020-05-21T14:05:13Z"
    }
  ],
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/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": "2020-05-21T14:05:13Z",
  "completedAt": "2020-05-21T14:05:13Z",
  "applicant": {
    "username": "string",
    "contact": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "suffix": "MD",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "emailAddresses": [
        {
          "_id": "ea1",
          "value": "api@apiture.com",
          "type": "personal"
        },
        {
          "_id": "ek3",
          "value": "support@apiture.com",
          "type": "work"
        }
      ],
      "preferredEmailAddressId": "ea1",
      "phones": [
        {
          "_id": "pa1",
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "_id": "da6",
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "preferredPhoneId": "pa1",
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "resident",
      "occupation": "officeAndAdministrativeSupport",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "_id": "wa1",
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha1",
      "identityVerification": {
        "provider": "IDology",
        "sessionId": "123456",
        "scoredAt": "2019-09-13T13:06:52.078Z",
        "score": "passed",
        "state": "verified"
      },
      "yearsAtAddress": 3,
      "mailingDifferentAddress": false,
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": false,
        "employmentStatus": "fullTime",
        "occupation": "officeAndAdministrativeSupport",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "N/A",
        "familyOfPoliticalFigure": false
      },
      "state": "active",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:deactivate": {
          "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "user": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "addresses": [
        {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
            }
          }
        }
      ],
      "preferredMailingAddressId": "stri",
      "emailAddresses": [
        {
          "_id": "pe1",
          "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
          "type": "personal",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "delete": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
            },
            "apiture:setAsPreferred": {
              "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
            }
          }
        }
      ],
      "preferredEmailAddressId": "stri",
      "phones": [
        {
          "_id": "hp1",
          "type": "home",
          "number": "555-555-5555"
        }
      ],
      "preferredPhoneId": "stri",
      "prefix": "string",
      "suffix": "string",
      "preferredName": "string",
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111",
          "expiration": {}
        }
      ],
      "preferredContactMethod": "unknown",
      "birthdate": "2020-05-21",
      "citizenship": [
        {
          "countryCode": "US",
          "state": "citizen"
        }
      ],
      "residencyStatus": "unknown",
      "occupation": "unknown",
      "otherOccupation": "string",
      "yearsAtAddress": "unknown",
      "kycAnswers": {
        "citizen": true,
        "permanentResident": true,
        "w9Withholdings": true,
        "employmentStatus": "unknown",
        "foreignPoliticalFigure": false,
        "countryPoliticalFigure": "string",
        "familyOfPoliticalFigure": true,
        "foreignPoliticalFigureCountry": "st",
        "foreignPoliticalFigureAssociation": "unknown"
      },
      "identityVerification": {
        "provider": "string",
        "sessionId": "string",
        "scoredAt": "2019-09-13T06:11:01.375Z",
        "score": "passed",
        "state": "verified"
      },
      "username": "string",
      "state": "active",
      "phoneNumbers": [
        {
          "_id": "hp1",
          "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
          "type": "home",
          "number": "555-555-5555",
          "state": "approved",
          "_links": {
            "self": {
              "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
            }
          }
        }
      ],
      "_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": "2eae46e1575c0a7b0115a4b3",
        "message": "Descriptive error message...",
        "statusCode": 422,
        "type": "errorType1",
        "remediation": "Remediation string...",
        "occurredAt": "2018-01-25T05:50:52.375Z",
        "errors": [
          {
            "_id": "ccdbe2c5c938a230667b3827",
            "message": "An optional embedded error"
          },
          {
            "_id": "dbe9088dcfe2460f229338a3",
            "message": "Another optional embedded error"
          }
        ],
        "_links": {
          "describedby": {
            "href": "https://developer.apiture.com/errors/errorType1"
          }
        }
      },
      "_id": "string",
      "customerId": "00047294723672"
    },
    "role": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "primaryUser",
      "label": "Primary User",
      "createdAt": "2018-02-01T13:07:01.375Z",
      "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
    },
    "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",
          "createdAt": "2018-01-12T10:15:17Z"
        },
        {
          "type": "quiz",
          "_links": {
            "self": {
              "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
            }
          },
          "state": "passed",
          "createdAt": "2018-01-12T10:19:41Z"
        }
      ]
    },
    "approvals": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
        "reason": "Invalid U.S. Address",
        "createdAt": "2018-04-17T10:04:46.375Z",
        "updatedAt": "2018-04-17T10:12:58.375Z",
        "_links": {
          "self": {
            "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:approvalType": {
            "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
          },
          "apiture:target": {
            "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
          }
        },
        "_embedded": {
          "approvalType": {
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
            "_links": {
              "self": {
                "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
              }
            },
            "name": "governmentId",
            "label": "Government Issued ID",
            "description": "A document that identifies a user"
          }
        }
      }
    ],
    "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": "productTermsAndConditions",
        "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/v2.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/v2.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": {
        "state": "passedWithRiskFactors",
        "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 watchlists"
          },
          {
            "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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string"
}

Digital Banking User Enrollment (v1.0.0)

Representation of the request to enroll a user in digital banking.

Links

Response and request bodies using this enrollment schema may contain the following links:

(Unknown)

Rel	Summary	Method
apiture:expire		(Unknown)
apiture:reject	Reject an enrollment	POST
apiture:approve	Approve an enrollment	POST
apiture:cancel	Cancel an enrollment	POST
apiture:workflow	Workflow	GET
apiture:approval	Enrollment Approval	GET

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.
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: pending - Available to be started (POST to the apiture:start link to start it). This state is reserved for future use. running - Started and has not completed or been canceled. blocked - Started but is blocked; there are no available workflow tasks. canceled - Canceled prior to completion expired - Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired. rejected - Completed but was rejected after review approved - Completed and approved The value is updated by the various enrollment or application operations. read-only Enumerated values: pending running blocked canceled expired rejected approved
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	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 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

enrollments

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/enrollments/v2.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 (v2.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	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 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 may 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.

applications

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/applications/v2.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 (v2.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	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 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 may 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.

applicant

{
  "username": "string",
  "contact": {
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
    "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
    "firstName": "John",
    "middleName": "Daniel",
    "lastName": "Smith",
    "preferredName": "John",
    "suffix": "MD",
    "identification": [
      {
        "type": "taxId",
        "value": "111-11-1111"
      }
    ],
    "emailAddresses": [
      {
        "_id": "ea1",
        "value": "api@apiture.com",
        "type": "personal"
      },
      {
        "_id": "ek3",
        "value": "support@apiture.com",
        "type": "work"
      }
    ],
    "preferredEmailAddressId": "ea1",
    "phones": [
      {
        "_id": "pa1",
        "type": "home",
        "number": "(555) 555-5555"
      },
      {
        "_id": "da6",
        "type": "mobile",
        "number": "(999) 555-5555"
      }
    ],
    "preferredPhoneId": "pa1",
    "birthdate": "1974-10-27",
    "citizenship": [
      {
        "countryCode": "US",
        "state": "citizen"
      }
    ],
    "residencyStatus": "resident",
    "occupation": "officeAndAdministrativeSupport",
    "addresses": [
      {
        "_id": "ha1",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US"
      },
      {
        "_id": "wa1",
        "type": "work",
        "addressLine1": "123 S 3rd Street",
        "addressLine2": "Apt 42",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28411-5405",
        "countryCode": "US"
      }
    ],
    "preferredMailingAddressId": "ha1",
    "identityVerification": {
      "provider": "IDology",
      "sessionId": "123456",
      "scoredAt": "2019-09-13T13:06:52.078Z",
      "score": "passed",
      "state": "verified"
    },
    "yearsAtAddress": 3,
    "mailingDifferentAddress": false,
    "kycAnswers": {
      "citizen": true,
      "permanentResident": true,
      "w9Withholdings": false,
      "employmentStatus": "fullTime",
      "occupation": "officeAndAdministrativeSupport",
      "foreignPoliticalFigure": false,
      "countryPoliticalFigure": "N/A",
      "familyOfPoliticalFigure": false
    },
    "state": "active",
    "createdAt": "2018-04-17T10:04:46.375Z",
    "updatedAt": "2018-04-17T10:12:58.375Z",
    "_links": {
      "self": {
        "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
      },
      "apiture:deactivate": {
        "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "user": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "addresses": [
      {
        "_id": "ha1",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US",
        "state": "approved",
        "_links": {
          "self": {
            "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
          }
        }
      }
    ],
    "preferredMailingAddressId": "stri",
    "emailAddresses": [
      {
        "_id": "pe1",
        "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
        "type": "personal",
        "number": "555-555-5555",
        "state": "approved",
        "_links": {
          "self": {
            "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
          },
          "delete": {
            "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
          },
          "apiture:setAsPreferred": {
            "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
          }
        }
      }
    ],
    "preferredEmailAddressId": "stri",
    "phones": [
      {
        "_id": "hp1",
        "type": "home",
        "number": "555-555-5555"
      }
    ],
    "preferredPhoneId": "stri",
    "prefix": "string",
    "suffix": "string",
    "preferredName": "string",
    "identification": [
      {
        "type": "taxId",
        "value": "111-11-1111",
        "expiration": {}
      }
    ],
    "preferredContactMethod": "unknown",
    "birthdate": "2020-05-21",
    "citizenship": [
      {
        "countryCode": "US",
        "state": "citizen"
      }
    ],
    "residencyStatus": "unknown",
    "occupation": "unknown",
    "otherOccupation": "string",
    "yearsAtAddress": "unknown",
    "kycAnswers": {
      "citizen": true,
      "permanentResident": true,
      "w9Withholdings": true,
      "employmentStatus": "unknown",
      "foreignPoliticalFigure": false,
      "countryPoliticalFigure": "string",
      "familyOfPoliticalFigure": true,
      "foreignPoliticalFigureCountry": "st",
      "foreignPoliticalFigureAssociation": "unknown"
    },
    "identityVerification": {
      "provider": "string",
      "sessionId": "string",
      "scoredAt": "2019-09-13T06:11:01.375Z",
      "score": "passed",
      "state": "verified"
    },
    "username": "string",
    "state": "active",
    "phoneNumbers": [
      {
        "_id": "hp1",
        "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
        "type": "home",
        "number": "555-555-5555",
        "state": "approved",
        "_links": {
          "self": {
            "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
          }
        }
      }
    ],
    "_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": "2eae46e1575c0a7b0115a4b3",
      "message": "Descriptive error message...",
      "statusCode": 422,
      "type": "errorType1",
      "remediation": "Remediation string...",
      "occurredAt": "2018-01-25T05:50:52.375Z",
      "errors": [
        {
          "_id": "ccdbe2c5c938a230667b3827",
          "message": "An optional embedded error"
        },
        {
          "_id": "dbe9088dcfe2460f229338a3",
          "message": "Another optional embedded error"
        }
      ],
      "_links": {
        "describedby": {
          "href": "https://developer.apiture.com/errors/errorType1"
        }
      }
    },
    "_id": "string",
    "customerId": "00047294723672"
  },
  "role": {
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
    "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
    "_links": {
      "self": {
        "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    },
    "name": "primaryUser",
    "label": "Primary User",
    "createdAt": "2018-02-01T13:07:01.375Z",
    "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
  },
  "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",
        "createdAt": "2018-01-12T10:15:17Z"
      },
      {
        "type": "quiz",
        "_links": {
          "self": {
            "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
          }
        },
        "state": "passed",
        "createdAt": "2018-01-12T10:19:41Z"
      }
    ]
  },
  "approvals": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_links": {
        "self": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
            }
          },
          "name": "governmentId",
          "label": "Government Issued ID",
          "description": "A document that identifies a user"
        }
      }
    }
  ],
  "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": "productTermsAndConditions",
      "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/v2.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/v2.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": {
      "state": "passedWithRiskFactors",
      "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 watchlists"
        },
        {
          "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 (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	contact A Contact object representing an individual contact.
user	summaryUser A User 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.
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

requiredDocument

{
  "label": "string",
  "type": "governmentId",
  "productTarget": "business",
  "documentUri": "string",
  "category": "driversLicense",
  "requireIfVerified": true
}

Required Document (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. Enumerated values: business personal
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. Enumerated values: driversLicense militaryIdentification passport socialSecurityCard stateIdentification taxForm utilityBill
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": "http://example.com",
  "contentType": "application/pdf",
  "revisionId": "2019:1.2.0",
  "revisedAt": "2020-05-21T14:05:13Z"
}

Document

Properties of a target document.

Properties

Name	Description
uri	string(uri) (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.) maxLength: 2048
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).

verifiedTransferAccount

{
  "title": "Verified Transfer Account (v1.0.0)",
  "description": "Details of the account, possibly an external account, used to fund the new account.",
  "type": "object",
  "properties": {
    "_links": {
      "title": "Links",
      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
      "type": "object",
      "x-apiture-key": "linkRelationName",
      "additionalProperties": {
        "x-apiture-version": "1.0.0",
        "title": "Link",
        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
        "required": [
          "href"
        ],
        "properties": {
          "href": {
            "type": "string",
            "format": "uri",
            "description": "The URI or URI template for the resource/operation this link refers to."
          },
          "type": {
            "type": "string",
            "description": "The media type for the resource."
          },
          "templated": {
            "type": "boolean",
            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
          },
          "title": {
            "type": "string",
            "description": "An optional human-readable localized title for the link."
          },
          "deprecation": {
            "type": "string",
            "format": "uri",
            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
          },
          "profile": {
            "type": "string",
            "format": "uri",
            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
          }
        },
        "example": {
          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
          "title": "Applicant"
        },
        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
        "x-apiture-namespace": "common",
        "type": "object",
        "x-apiture-flattened": true
      },
      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
      "x-apiture-namespace": "common",
      "x-apiture-version": "1.0.0",
      "properties": {},
      "x-apiture-flattened": true
    },
    "_embedded": {
      "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
      "type": "object"
    },
    "_profile": {
      "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
      "type": "string",
      "format": "uri"
    },
    "_error": {
      "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
      "type": "object",
      "allOf": [
        {
          "x-apiture-version": "2.0.0",
          "title": "Error",
          "description": "Describes an error in an API request or in a service called via the API.",
          "required": [
            "message"
          ],
          "properties": {
            "message": {
              "type": "string",
              "description": "A localized message string describing the error condition."
            },
            "_id": {
              "description": "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.",
              "readOnly": true,
              "type": "string"
            },
            "statusCode": {
              "description": "The HTTP status code associate with this error.",
              "type": "integer",
              "minimum": 100,
              "maximum": 599,
              "example": 422
            },
            "type": {
              "type": "string",
              "description": "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": {
              "type": "string",
              "format": "date-time",
              "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
              "example": "2018-02-02T03:37:15.375Z"
            },
            "attributes": {
              "description": "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`.",
              "allOf": [
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Attributes",
                  "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                  "type": "object",
                  "x-apiture-key": "attributeName",
                  "additionalProperties": {
                    "x-apiture-version": "2.0.0",
                    "title": "Attribute Value",
                    "description": "The data associated with this attribute.",
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "properties": {},
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "properties": {},
                  "x-apiture-flattened": true
                }
              ]
            },
            "remediation": {
              "type": "string",
              "description": "An optional localized string which provides hints for how the user or client can resolve the error."
            },
            "errors": {
              "description": "An optional array of nested error objects. This property is not always present.",
              "type": "array",
              "items": "[Circular]"
            },
            "_links": {
              "title": "Links",
              "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
              "type": "object",
              "x-apiture-key": "linkRelationName",
              "additionalProperties": {
                "x-apiture-version": "1.0.0",
                "title": "Link",
                "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                "required": [
                  "href"
                ],
                "properties": {
                  "href": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI or URI template for the resource/operation this link refers to."
                  },
                  "type": {
                    "type": "string",
                    "description": "The media type for the resource."
                  },
                  "templated": {
                    "type": "boolean",
                    "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                  },
                  "title": {
                    "type": "string",
                    "description": "An optional human-readable localized title for the link."
                  },
                  "deprecation": {
                    "type": "string",
                    "format": "uri",
                    "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                  },
                  "profile": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                  }
                },
                "example": {
                  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                  "title": "Applicant"
                },
                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                "x-apiture-namespace": "common",
                "type": "object",
                "x-apiture-flattened": true
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
              "x-apiture-namespace": "common",
              "x-apiture-version": "1.0.0",
              "properties": {},
              "x-apiture-flattened": true
            }
          },
          "example": {
            "_id": "2eae46e1575c0a7b0115a4b3",
            "message": "Descriptive error message...",
            "statusCode": 422,
            "type": "errorType1",
            "remediation": "Remediation string...",
            "occurredAt": "2018-01-25T05:50:52.375Z",
            "errors": [
              {
                "_id": "ccdbe2c5c938a230667b3827",
                "message": "An optional embedded error"
              },
              {
                "_id": "dbe9088dcfe2460f229338a3",
                "message": "Another optional embedded error"
              }
            ],
            "_links": {
              "describedby": {
                "href": "https://developer.apiture.com/errors/errorType1"
              }
            }
          },
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
          "x-apiture-namespace": "common",
          "type": "object",
          "x-apiture-flattened": true
        }
      ]
    },
    "accountTitle": {
      "description": "The title of the account. Traditionally, this is the name of the account holder. This field is deprecated and will be removed in a future release; use `title` instead.",
      "maxLength": 512,
      "type": "string",
      "example": "John Smith"
    },
    "title": {
      "description": "The title of the account. Traditionally, this is the name of the account holder.",
      "maxLength": 512,
      "type": "string",
      "example": "John Smith"
    },
    "institutionName": {
      "description": "The name of the financial institution.",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "example": "3rd Party Bank",
      "readOnly": true
    },
    "routingNumber": {
      "description": "The account routing number which identifies the financial institution. The full routing number and full account number are required to fully identify the account.",
      "type": "string",
      "minLength": 9,
      "maxLength": 9,
      "example": "021000021",
      "readOnly": true
    },
    "accountNumbers": {
      "description": "The account numbers for this account",
      "type": "object",
      "allOf": [
        {
          "title": "Account Numbers",
          "description": "Different representations of an account number.",
          "properties": {
            "masked": {
              "description": "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.",
              "type": "string",
              "minLength": 8,
              "maxLength": 32,
              "readOnly": true,
              "example": "*************3210"
            },
            "full": {
              "description": "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.",
              "type": "string",
              "minLength": 4,
              "maxLength": 17,
              "example": "9876543210",
              "readOnly": true
            }
          },
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/accountNumbers/v1.0.0/model.json",
          "x-apiture-namespace": "common",
          "x-apiture-version": "1.0.0",
          "type": "object",
          "x-apiture-flattened": true
        }
      ],
      "readOnly": true
    },
    "ifxType": {
      "description": "A code which identifies the product type. This is one of the [IFX AcctType](https://ifxforum.org) values.",
      "allOf": [
        {
          "title": "IFX Account Type (v1.0.0)",
          "description": "A code which identifies the product type. This is one of the [IFX AcctType](https://ifxforum.org) values. Labels and descriptions for the enumeration values are in the `ifxType` key in the response of the `getLabels` operation.\n\n<strong><code>ifxType</code></strong> strings may have one of the following\n[enumerated values](https://developer.apiture.com/concepts/label-groups#enumerations) values\n(described by the named ifxType)\n\n<table>\n<tr>\n  <th>Value</th><th>Description</th>\n</tr>\n\nThese enumeration values are further described by the [label group](https://developer.apiture.com/concepts/label-groups)\nnamed `ifxType` in the response from the [`getLabels`](#op-getLabels) operation.\n\n<tr>\n    <td><strong><code>CCA</code></strong></td><td>Credit card account</td>\n    </tr>\n<tr>\n    <td><strong><code>CDA</code></strong></td><td>Certificate of deposit account (CD)</td>\n    </tr>\n<tr>\n    <td><strong><code>CLA</code></strong></td><td>Commercial loan account</td>\n    </tr>\n<tr>\n    <td><strong><code>CMA</code></strong></td><td>Cash management account</td>\n    </tr>\n<tr>\n    <td><strong><code>DDA</code></strong></td><td>Demand deposit account</td>\n    </tr>\n<tr>\n    <td><strong><code>EQU</code></strong></td><td>Home equity loan</td>\n    </tr>\n<tr>\n    <td><strong><code>GLA</code></strong></td><td>General ledger account</td>\n    </tr>\n<tr>\n    <td><strong><code>ILA</code></strong></td><td>Installment loan account</td>\n    </tr>\n<tr>\n    <td><strong><code>INV</code></strong></td><td>Investment account</td>\n    </tr>\n<tr>\n    <td><strong><code>IRA</code></strong></td><td>Individual retirement account</td>\n    </tr>\n<tr>\n    <td><strong><code>IRL</code></strong></td><td>Accounts held in Ireland</td>\n    </tr>\n<tr>\n    <td><strong><code>LOC</code></strong></td><td>Consumer line of credit</td>\n    </tr>\n<tr>\n    <td><strong><code>MLA</code></strong></td><td>Military Lending Account: Credit facility held by former US service member</td>\n    </tr>\n<tr>\n    <td><strong><code>MMA</code></strong></td><td>Money market account</td>\n    </tr>\n<tr>\n    <td><strong><code>PBA</code></strong></td><td>Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.</td>\n    </tr>\n<tr>\n    <td><strong><code>PPA</code></strong></td><td>Private pension administrator</td>\n    </tr>\n<tr>\n    <td><strong><code>RWD</code></strong></td><td>Reward accounts</td>\n    </tr>\n<tr>\n    <td><strong><code>SDA</code></strong></td><td>Savings deposit account</td>\n    </tr>\n</table>\n\n\nThis schema is version `v1.0.0`.",
          "x-apiture-enum": "ifxType",
          "type": "object",
          "enum": [
            "CCA",
            "CDA",
            "CLA",
            "CMA",
            "DDA",
            "EQU",
            "GLA",
            "ILA",
            "INV",
            "IRA",
            "IRL",
            "LOC",
            "MLA",
            "MMA",
            "PBA",
            "PPA",
            "RWD",
            "SDA"
          ],
          "x-apiture-version": "1.0.0",
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/products/ifxType/v1.0.0/model.json",
          "x-apiture-namespace": "products",
          "properties": {},
          "x-apiture-flattened": true
        }
      ],
      "readOnly": true
    },
    "verificationReport": {
      "description": "If this funding account is a new external account, this is an account verification report from an external account verification provider. It contains a pass/fail result based on risk factors. This property does not exist if the account is an internal account at this financial institution, or if this account is an external account that the user verified before starting this application.",
      "type": "object",
      "allOf": [
        {
          "x-apiture-version": "2.0.0",
          "title": "Verification Report",
          "description": "Representation of verification report resources.",
          "example": {
            "createdAt": "2018-04-17T10:04:46.375Z",
            "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
            "_embedded": {},
            "input": {
              "businessName": "ABC EXAMPLE CO.",
              "phone": "555-555-1234",
              "identification": [
                {
                  "type": "taxId",
                  "value": "12-347894309"
                }
              ],
              "authorizedSigners": [
                {
                  "firstName": "Jane",
                  "lastName": "Doe",
                  "identification": [
                    {
                      "type": "taxId",
                      "value": "121-34-5431"
                    }
                  ],
                  "birthdate": "1980-12-01",
                  "email": "email@email.com"
                }
              ],
              "addresses": [
                {
                  "addressLine1": "3212 N. 2nd Ave.",
                  "city": "Wilmington",
                  "regionCode": "NC",
                  "postalCode": "28412"
                }
              ]
            },
            "reportScoringSummary": {
              "transactionId": "578490325jk439834yuf43",
              "state": "failed",
              "businessVerification": [
                {
                  "value": 40,
                  "description": "Strong verification of the input data is confirmed"
                }
              ],
              "businessRiskFactors": [
                {
                  "riskCode": "20",
                  "description": "Unable to verify business address on business records"
                },
                {
                  "riskCode": "21",
                  "description": "Unable to verify business TIN on business records"
                }
              ],
              "comprehensiveVerificationScores": [
                {
                  "inputRepNumber": "1",
                  "score": 20,
                  "description": "Full name, address, phone, SSN verified"
                }
              ],
              "authorizedRepresentativeRiskFactors": [
                {
                  "riskCode": "81",
                  "description": "The input date-of-birth was missing or incomplete"
                },
                {
                  "riskCode": "25",
                  "description": "Unable to verify address"
                }
              ]
            },
            "reportResults": {}
          },
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/verificationReport/v2.0.0/model.json",
          "x-apiture-namespace": "businessVerifications",
          "x-apiture-composition": [
            {
              "x-apiture-version": "2.0.0",
              "title": "Abstract Resource",
              "description": "An abstract schema used to define other schemas for request and response bodies. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation. This model contains hypermedia `_links`, and either optional domain object data with `_profile` and optional `_embedded` objects, or an `_error` object. In responses, if the operation was successful, this object will not include the `_error`, but if the operation was a 4xx or 5xx error, this object will not include `_embedded` or any data fields, only `_error` and optionally `_links`.",
              "example": {
                "_profile": "{uri of resource profile.json}",
                "_links": {
                  "self": {
                    "href": "{uri of current resource}"
                  }
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/model.json",
              "x-apiture-namespace": "common",
              "x-apiture-composition": [
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Abstract Request",
                  "description": "An abstract schema used to define other request-only schemas. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation, minus the `_error` defined in `abstractResource`.",
                  "properties": {
                    "_links": {
                      "title": "Links",
                      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                      "type": "object",
                      "x-apiture-key": "linkRelationName",
                      "additionalProperties": {
                        "x-apiture-version": "1.0.0",
                        "title": "Link",
                        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                        "required": [
                          "href"
                        ],
                        "properties": {
                          "href": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI or URI template for the resource/operation this link refers to."
                          },
                          "type": {
                            "type": "string",
                            "description": "The media type for the resource."
                          },
                          "templated": {
                            "type": "boolean",
                            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                          },
                          "title": {
                            "type": "string",
                            "description": "An optional human-readable localized title for the link."
                          },
                          "deprecation": {
                            "type": "string",
                            "format": "uri",
                            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                          },
                          "profile": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                          }
                        },
                        "example": {
                          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                          "title": "Applicant"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    },
                    "_embedded": {
                      "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                      "type": "object"
                    },
                    "_profile": {
                      "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                      "type": "string",
                      "format": "uri"
                    }
                  },
                  "example": {
                    "_profile": "{uri of resource profile.json}",
                    "_links": {
                      "self": {
                        "href": "{uri of current resource}"
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "type": "object",
                  "x-apiture-flattened": true
                },
                {
                  "properties": [
                    "_error"
                  ]
                }
              ],
              "type": "object",
              "properties": {
                "_links": {
                  "title": "Links",
                  "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                  "type": "object",
                  "x-apiture-key": "linkRelationName",
                  "additionalProperties": {
                    "x-apiture-version": "1.0.0",
                    "title": "Link",
                    "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI or URI template for the resource/operation this link refers to."
                      },
                      "type": {
                        "type": "string",
                        "description": "The media type for the resource."
                      },
                      "templated": {
                        "type": "boolean",
                        "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                      },
                      "title": {
                        "type": "string",
                        "description": "An optional human-readable localized title for the link."
                      },
                      "deprecation": {
                        "type": "string",
                        "format": "uri",
                        "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                      },
                      "profile": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                      }
                    },
                    "example": {
                      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                      "title": "Applicant"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                },
                "_embedded": {
                  "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                  "type": "object"
                },
                "_profile": {
                  "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                  "type": "string",
                  "format": "uri"
                },
                "_error": {
                  "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
                  "type": "object",
                  "allOf": [
                    {
                      "x-apiture-version": "2.0.0",
                      "title": "Error",
                      "description": "Describes an error in an API request or in a service called via the API.",
                      "required": [
                        "message"
                      ],
                      "properties": {
                        "message": {
                          "type": "string",
                          "description": "A localized message string describing the error condition."
                        },
                        "_id": {
                          "description": "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.",
                          "readOnly": true,
                          "type": "string"
                        },
                        "statusCode": {
                          "description": "The HTTP status code associate with this error.",
                          "type": "integer",
                          "minimum": 100,
                          "maximum": 599,
                          "example": 422
                        },
                        "type": {
                          "type": "string",
                          "description": "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": {
                          "type": "string",
                          "format": "date-time",
                          "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                          "example": "2018-02-02T03:37:15.375Z"
                        },
                        "attributes": {
                          "description": "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`.",
                          "allOf": [
                            {
                              "x-apiture-version": "2.0.0",
                              "title": "Attributes",
                              "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                              "type": "object",
                              "x-apiture-key": "attributeName",
                              "additionalProperties": {
                                "x-apiture-version": "2.0.0",
                                "title": "Attribute Value",
                                "description": "The data associated with this attribute.",
                                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                                "x-apiture-namespace": "common",
                                "type": "object",
                                "properties": {},
                                "x-apiture-flattened": true
                              },
                              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                              "x-apiture-namespace": "common",
                              "properties": {},
                              "x-apiture-flattened": true
                            }
                          ]
                        },
                        "remediation": {
                          "type": "string",
                          "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                        },
                        "errors": {
                          "description": "An optional array of nested error objects. This property is not always present.",
                          "type": "array",
                          "items": "[Circular]"
                        },
                        "_links": {
                          "title": "Links",
                          "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                          "type": "object",
                          "x-apiture-key": "linkRelationName",
                          "additionalProperties": {
                            "x-apiture-version": "1.0.0",
                            "title": "Link",
                            "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                            "required": [
                              "href"
                            ],
                            "properties": {
                              "href": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI or URI template for the resource/operation this link refers to."
                              },
                              "type": {
                                "type": "string",
                                "description": "The media type for the resource."
                              },
                              "templated": {
                                "type": "boolean",
                                "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                              },
                              "title": {
                                "type": "string",
                                "description": "An optional human-readable localized title for the link."
                              },
                              "deprecation": {
                                "type": "string",
                                "format": "uri",
                                "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                              },
                              "profile": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                              }
                            },
                            "example": {
                              "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                              "title": "Applicant"
                            },
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "x-apiture-version": "1.0.0",
                          "properties": {},
                          "x-apiture-flattened": true
                        }
                      },
                      "example": {
                        "_id": "2eae46e1575c0a7b0115a4b3",
                        "message": "Descriptive error message...",
                        "statusCode": 422,
                        "type": "errorType1",
                        "remediation": "Remediation string...",
                        "occurredAt": "2018-01-25T05:50:52.375Z",
                        "errors": [
                          {
                            "_id": "ccdbe2c5c938a230667b3827",
                            "message": "An optional embedded error"
                          },
                          {
                            "_id": "dbe9088dcfe2460f229338a3",
                            "message": "Another optional embedded error"
                          }
                        ],
                        "_links": {
                          "describedby": {
                            "href": "https://developer.apiture.com/errors/errorType1"
                          }
                        }
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "type": "object",
                      "x-apiture-flattened": true
                    }
                  ]
                }
              },
              "x-apiture-flattened": true
            },
            {
              "x-apiture-version": "2.0.0",
              "title": "Verification Report Summary",
              "description": "Summary representation of a verification report resource in verification report 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.",
              "example": {
                "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
                "_profile": "https://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json",
                "_links": {
                  "self": {
                    "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
                  }
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/summaryVerificationReport/v2.0.0/model.json",
              "x-apiture-namespace": "businessVerifications",
              "x-apiture-composition": [
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Abstract Resource",
                  "description": "An abstract schema used to define other schemas for request and response bodies. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation. This model contains hypermedia `_links`, and either optional domain object data with `_profile` and optional `_embedded` objects, or an `_error` object. In responses, if the operation was successful, this object will not include the `_error`, but if the operation was a 4xx or 5xx error, this object will not include `_embedded` or any data fields, only `_error` and optionally `_links`.",
                  "example": {
                    "_profile": "{uri of resource profile.json}",
                    "_links": {
                      "self": {
                        "href": "{uri of current resource}"
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-composition": [
                    {
                      "x-apiture-version": "2.0.0",
                      "title": "Abstract Request",
                      "description": "An abstract schema used to define other request-only schemas. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation, minus the `_error` defined in `abstractResource`.",
                      "properties": {
                        "_links": {
                          "title": "Links",
                          "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                          "type": "object",
                          "x-apiture-key": "linkRelationName",
                          "additionalProperties": {
                            "x-apiture-version": "1.0.0",
                            "title": "Link",
                            "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                            "required": [
                              "href"
                            ],
                            "properties": {
                              "href": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI or URI template for the resource/operation this link refers to."
                              },
                              "type": {
                                "type": "string",
                                "description": "The media type for the resource."
                              },
                              "templated": {
                                "type": "boolean",
                                "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                              },
                              "title": {
                                "type": "string",
                                "description": "An optional human-readable localized title for the link."
                              },
                              "deprecation": {
                                "type": "string",
                                "format": "uri",
                                "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                              },
                              "profile": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                              }
                            },
                            "example": {
                              "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                              "title": "Applicant"
                            },
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "x-apiture-version": "1.0.0",
                          "properties": {},
                          "x-apiture-flattened": true
                        },
                        "_embedded": {
                          "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                          "type": "object"
                        },
                        "_profile": {
                          "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                          "type": "string",
                          "format": "uri"
                        }
                      },
                      "example": {
                        "_profile": "{uri of resource profile.json}",
                        "_links": {
                          "self": {
                            "href": "{uri of current resource}"
                          }
                        }
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "type": "object",
                      "x-apiture-flattened": true
                    },
                    {
                      "properties": [
                        "_error"
                      ]
                    }
                  ],
                  "type": "object",
                  "properties": {
                    "_links": {
                      "title": "Links",
                      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                      "type": "object",
                      "x-apiture-key": "linkRelationName",
                      "additionalProperties": {
                        "x-apiture-version": "1.0.0",
                        "title": "Link",
                        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                        "required": [
                          "href"
                        ],
                        "properties": {
                          "href": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI or URI template for the resource/operation this link refers to."
                          },
                          "type": {
                            "type": "string",
                            "description": "The media type for the resource."
                          },
                          "templated": {
                            "type": "boolean",
                            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                          },
                          "title": {
                            "type": "string",
                            "description": "An optional human-readable localized title for the link."
                          },
                          "deprecation": {
                            "type": "string",
                            "format": "uri",
                            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                          },
                          "profile": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                          }
                        },
                        "example": {
                          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                          "title": "Applicant"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    },
                    "_embedded": {
                      "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                      "type": "object"
                    },
                    "_profile": {
                      "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                      "type": "string",
                      "format": "uri"
                    },
                    "_error": {
                      "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
                      "type": "object",
                      "allOf": [
                        {
                          "x-apiture-version": "2.0.0",
                          "title": "Error",
                          "description": "Describes an error in an API request or in a service called via the API.",
                          "required": [
                            "message"
                          ],
                          "properties": {
                            "message": {
                              "type": "string",
                              "description": "A localized message string describing the error condition."
                            },
                            "_id": {
                              "description": "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.",
                              "readOnly": true,
                              "type": "string"
                            },
                            "statusCode": {
                              "description": "The HTTP status code associate with this error.",
                              "type": "integer",
                              "minimum": 100,
                              "maximum": 599,
                              "example": 422
                            },
                            "type": {
                              "type": "string",
                              "description": "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": {
                              "type": "string",
                              "format": "date-time",
                              "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                              "example": "2018-02-02T03:37:15.375Z"
                            },
                            "attributes": {
                              "description": "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`.",
                              "allOf": [
                                {
                                  "x-apiture-version": "2.0.0",
                                  "title": "Attributes",
                                  "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                                  "type": "object",
                                  "x-apiture-key": "attributeName",
                                  "additionalProperties": {
                                    "x-apiture-version": "2.0.0",
                                    "title": "Attribute Value",
                                    "description": "The data associated with this attribute.",
                                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                                    "x-apiture-namespace": "common",
                                    "type": "object",
                                    "properties": {},
                                    "x-apiture-flattened": true
                                  },
                                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                                  "x-apiture-namespace": "common",
                                  "properties": {},
                                  "x-apiture-flattened": true
                                }
                              ]
                            },
                            "remediation": {
                              "type": "string",
                              "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                            },
                            "errors": {
                              "description": "An optional array of nested error objects. This property is not always present.",
                              "type": "array",
                              "items": "[Circular]"
                            },
                            "_links": {
                              "title": "Links",
                              "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                              "type": "object",
                              "x-apiture-key": "linkRelationName",
                              "additionalProperties": {
                                "x-apiture-version": "1.0.0",
                                "title": "Link",
                                "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                                "required": [
                                  "href"
                                ],
                                "properties": {
                                  "href": {
                                    "type": "string",
                                    "format": "uri",
                                    "description": "The URI or URI template for the resource/operation this link refers to."
                                  },
                                  "type": {
                                    "type": "string",
                                    "description": "The media type for the resource."
                                  },
                                  "templated": {
                                    "type": "boolean",
                                    "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                                  },
                                  "title": {
                                    "type": "string",
                                    "description": "An optional human-readable localized title for the link."
                                  },
                                  "deprecation": {
                                    "type": "string",
                                    "format": "uri",
                                    "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                                  },
                                  "profile": {
                                    "type": "string",
                                    "format": "uri",
                                    "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                                  }
                                },
                                "example": {
                                  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                                  "title": "Applicant"
                                },
                                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                                "x-apiture-namespace": "common",
                                "type": "object",
                                "x-apiture-flattened": true
                              },
                              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                              "x-apiture-namespace": "common",
                              "x-apiture-version": "1.0.0",
                              "properties": {},
                              "x-apiture-flattened": true
                            }
                          },
                          "example": {
                            "_id": "2eae46e1575c0a7b0115a4b3",
                            "message": "Descriptive error message...",
                            "statusCode": 422,
                            "type": "errorType1",
                            "remediation": "Remediation string...",
                            "occurredAt": "2018-01-25T05:50:52.375Z",
                            "errors": [
                              {
                                "_id": "ccdbe2c5c938a230667b3827",
                                "message": "An optional embedded error"
                              },
                              {
                                "_id": "dbe9088dcfe2460f229338a3",
                                "message": "Another optional embedded error"
                              }
                            ],
                            "_links": {
                              "describedby": {
                                "href": "https://developer.apiture.com/errors/errorType1"
                              }
                            }
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "type": "object",
                          "x-apiture-flattened": true
                        }
                      ]
                    }
                  },
                  "x-apiture-flattened": true
                },
                {
                  "properties": [
                    "_id",
                    "reportScoringSummary"
                  ]
                }
              ],
              "type": "object",
              "properties": {
                "_links": {
                  "title": "Links",
                  "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                  "type": "object",
                  "x-apiture-key": "linkRelationName",
                  "additionalProperties": {
                    "x-apiture-version": "1.0.0",
                    "title": "Link",
                    "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI or URI template for the resource/operation this link refers to."
                      },
                      "type": {
                        "type": "string",
                        "description": "The media type for the resource."
                      },
                      "templated": {
                        "type": "boolean",
                        "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                      },
                      "title": {
                        "type": "string",
                        "description": "An optional human-readable localized title for the link."
                      },
                      "deprecation": {
                        "type": "string",
                        "format": "uri",
                        "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                      },
                      "profile": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                      }
                    },
                    "example": {
                      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                      "title": "Applicant"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                },
                "_embedded": {
                  "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                  "type": "object"
                },
                "_profile": {
                  "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                  "type": "string",
                  "format": "uri"
                },
                "_error": {
                  "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
                  "type": "object",
                  "allOf": [
                    {
                      "x-apiture-version": "2.0.0",
                      "title": "Error",
                      "description": "Describes an error in an API request or in a service called via the API.",
                      "required": [
                        "message"
                      ],
                      "properties": {
                        "message": {
                          "type": "string",
                          "description": "A localized message string describing the error condition."
                        },
                        "_id": {
                          "description": "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.",
                          "readOnly": true,
                          "type": "string"
                        },
                        "statusCode": {
                          "description": "The HTTP status code associate with this error.",
                          "type": "integer",
                          "minimum": 100,
                          "maximum": 599,
                          "example": 422
                        },
                        "type": {
                          "type": "string",
                          "description": "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": {
                          "type": "string",
                          "format": "date-time",
                          "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                          "example": "2018-02-02T03:37:15.375Z"
                        },
                        "attributes": {
                          "description": "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`.",
                          "allOf": [
                            {
                              "x-apiture-version": "2.0.0",
                              "title": "Attributes",
                              "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                              "type": "object",
                              "x-apiture-key": "attributeName",
                              "additionalProperties": {
                                "x-apiture-version": "2.0.0",
                                "title": "Attribute Value",
                                "description": "The data associated with this attribute.",
                                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                                "x-apiture-namespace": "common",
                                "type": "object",
                                "properties": {},
                                "x-apiture-flattened": true
                              },
                              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                              "x-apiture-namespace": "common",
                              "properties": {},
                              "x-apiture-flattened": true
                            }
                          ]
                        },
                        "remediation": {
                          "type": "string",
                          "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                        },
                        "errors": {
                          "description": "An optional array of nested error objects. This property is not always present.",
                          "type": "array",
                          "items": "[Circular]"
                        },
                        "_links": {
                          "title": "Links",
                          "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                          "type": "object",
                          "x-apiture-key": "linkRelationName",
                          "additionalProperties": {
                            "x-apiture-version": "1.0.0",
                            "title": "Link",
                            "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                            "required": [
                              "href"
                            ],
                            "properties": {
                              "href": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI or URI template for the resource/operation this link refers to."
                              },
                              "type": {
                                "type": "string",
                                "description": "The media type for the resource."
                              },
                              "templated": {
                                "type": "boolean",
                                "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                              },
                              "title": {
                                "type": "string",
                                "description": "An optional human-readable localized title for the link."
                              },
                              "deprecation": {
                                "type": "string",
                                "format": "uri",
                                "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                              },
                              "profile": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                              }
                            },
                            "example": {
                              "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                              "title": "Applicant"
                            },
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "x-apiture-version": "1.0.0",
                          "properties": {},
                          "x-apiture-flattened": true
                        }
                      },
                      "example": {
                        "_id": "2eae46e1575c0a7b0115a4b3",
                        "message": "Descriptive error message...",
                        "statusCode": 422,
                        "type": "errorType1",
                        "remediation": "Remediation string...",
                        "occurredAt": "2018-01-25T05:50:52.375Z",
                        "errors": [
                          {
                            "_id": "ccdbe2c5c938a230667b3827",
                            "message": "An optional embedded error"
                          },
                          {
                            "_id": "dbe9088dcfe2460f229338a3",
                            "message": "Another optional embedded error"
                          }
                        ],
                        "_links": {
                          "describedby": {
                            "href": "https://developer.apiture.com/errors/errorType1"
                          }
                        }
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "type": "object",
                      "x-apiture-flattened": true
                    }
                  ]
                },
                "_id": {
                  "description": "The unique identifier for this verification report resource. This is an immutable opaque string.",
                  "readOnly": true,
                  "type": "string"
                },
                "reportScoringSummary": {
                  "title": "Verification Report Summary",
                  "description": "Model schema for business verification report summary.",
                  "properties": {
                    "transactionId": {
                      "description": "The unique transactionId for this verification report used for tracking this verification report",
                      "type": "string"
                    },
                    "state": {
                      "type": "string",
                      "description": "The state of a verification report.  _passed_ indicates that the Business was successfully verified based upon the supplied information, _failed_ indicates it was not.",
                      "enum": [
                        "passed",
                        "failed"
                      ]
                    },
                    "businessVerifications": {
                      "description": "A list of business verification scores.",
                      "type": "array",
                      "items": {
                        "title": "Business Verification Score",
                        "description": "An score that summarizes the verification of the input information. This objects contains a score `value` and accompanying `description`.",
                        "properties": {
                          "value": {
                            "description": "The business verification score value",
                            "type": "string"
                          },
                          "description": {
                            "description": "The business verification score description",
                            "type": "string"
                          }
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/businessVerificationScore/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "type": "object",
                        "x-apiture-flattened": true
                      }
                    },
                    "businessRiskFactors": {
                      "description": "A list of business verification risk factors.",
                      "type": "array",
                      "items": {
                        "title": "Risk Factor",
                        "description": "Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.",
                        "properties": {
                          "riskCode": {
                            "description": "The risk factor risk code",
                            "type": "string"
                          },
                          "description": {
                            "description": "The risk code description",
                            "type": "string"
                          }
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/riskFactor/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "type": "object",
                        "x-apiture-flattened": true
                      }
                    },
                    "comprehensiveVerificationScores": {
                      "description": "A list of comprehensive business verification scores.",
                      "type": "array",
                      "items": {
                        "title": "Authorized Representative Comprehensive Verification Score",
                        "description": "The comprehensive verification score is a risk verification score for the authorized representative.",
                        "properties": {
                          "inputRepNumber": {
                            "description": "the rep number for the authorized representative",
                            "type": "string"
                          },
                          "score": {
                            "description": "The comprehensive verification score is a risk verification score of the authorized representative",
                            "type": "integer"
                          },
                          "description": {
                            "description": "The description for the CVI value",
                            "type": "string"
                          }
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/comprehensiveVerificationScore/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "type": "object",
                        "x-apiture-flattened": true
                      }
                    },
                    "authorizedRepresentativeRiskFactors": {
                      "description": "A list of representative business risk factors.",
                      "type": "array",
                      "items": {
                        "title": "Risk Factor",
                        "description": "Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.",
                        "properties": {
                          "riskCode": {
                            "description": "The risk factor risk code",
                            "type": "string"
                          },
                          "description": {
                            "description": "The risk code description",
                            "type": "string"
                          }
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/riskFactor/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "type": "object",
                        "x-apiture-flattened": true
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/verificationReportScoringSummary/v1.0.0/model.json",
                  "x-apiture-namespace": "businessVerifications",
                  "x-apiture-version": "1.0.0",
                  "type": "object",
                  "x-apiture-flattened": true
                }
              },
              "x-apiture-flattened": true
            },
            {
              "properties": [
                "createdAt",
                "_embedded",
                "input",
                "reportScoringSummary",
                "reportResults"
              ]
            }
          ],
          "type": "object",
          "properties": {
            "_links": {
              "title": "Links",
              "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
              "type": "object",
              "x-apiture-key": "linkRelationName",
              "additionalProperties": {
                "x-apiture-version": "1.0.0",
                "title": "Link",
                "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                "required": [
                  "href"
                ],
                "properties": {
                  "href": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI or URI template for the resource/operation this link refers to."
                  },
                  "type": {
                    "type": "string",
                    "description": "The media type for the resource."
                  },
                  "templated": {
                    "type": "boolean",
                    "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                  },
                  "title": {
                    "type": "string",
                    "description": "An optional human-readable localized title for the link."
                  },
                  "deprecation": {
                    "type": "string",
                    "format": "uri",
                    "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                  },
                  "profile": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                  }
                },
                "example": {
                  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                  "title": "Applicant"
                },
                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                "x-apiture-namespace": "common",
                "type": "object",
                "x-apiture-flattened": true
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
              "x-apiture-namespace": "common",
              "x-apiture-version": "1.0.0",
              "properties": {},
              "x-apiture-flattened": true
            },
            "_embedded": {
              "description": "The objects which participate in this verification report",
              "type": "object"
            },
            "_profile": {
              "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
              "type": "string",
              "format": "uri"
            },
            "_error": {
              "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
              "type": "object",
              "allOf": [
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Error",
                  "description": "Describes an error in an API request or in a service called via the API.",
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "A localized message string describing the error condition."
                    },
                    "_id": {
                      "description": "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.",
                      "readOnly": true,
                      "type": "string"
                    },
                    "statusCode": {
                      "description": "The HTTP status code associate with this error.",
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 599,
                      "example": 422
                    },
                    "type": {
                      "type": "string",
                      "description": "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": {
                      "type": "string",
                      "format": "date-time",
                      "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                      "example": "2018-02-02T03:37:15.375Z"
                    },
                    "attributes": {
                      "description": "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`.",
                      "allOf": [
                        {
                          "x-apiture-version": "2.0.0",
                          "title": "Attributes",
                          "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                          "type": "object",
                          "x-apiture-key": "attributeName",
                          "additionalProperties": {
                            "x-apiture-version": "2.0.0",
                            "title": "Attribute Value",
                            "description": "The data associated with this attribute.",
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "properties": {},
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "properties": {},
                          "x-apiture-flattened": true
                        }
                      ]
                    },
                    "remediation": {
                      "type": "string",
                      "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                    },
                    "errors": {
                      "description": "An optional array of nested error objects. This property is not always present.",
                      "type": "array",
                      "items": "[Circular]"
                    },
                    "_links": {
                      "title": "Links",
                      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                      "type": "object",
                      "x-apiture-key": "linkRelationName",
                      "additionalProperties": {
                        "x-apiture-version": "1.0.0",
                        "title": "Link",
                        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                        "required": [
                          "href"
                        ],
                        "properties": {
                          "href": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI or URI template for the resource/operation this link refers to."
                          },
                          "type": {
                            "type": "string",
                            "description": "The media type for the resource."
                          },
                          "templated": {
                            "type": "boolean",
                            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                          },
                          "title": {
                            "type": "string",
                            "description": "An optional human-readable localized title for the link."
                          },
                          "deprecation": {
                            "type": "string",
                            "format": "uri",
                            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                          },
                          "profile": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                          }
                        },
                        "example": {
                          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                          "title": "Applicant"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    }
                  },
                  "example": {
                    "_id": "2eae46e1575c0a7b0115a4b3",
                    "message": "Descriptive error message...",
                    "statusCode": 422,
                    "type": "errorType1",
                    "remediation": "Remediation string...",
                    "occurredAt": "2018-01-25T05:50:52.375Z",
                    "errors": [
                      {
                        "_id": "ccdbe2c5c938a230667b3827",
                        "message": "An optional embedded error"
                      },
                      {
                        "_id": "dbe9088dcfe2460f229338a3",
                        "message": "Another optional embedded error"
                      }
                    ],
                    "_links": {
                      "describedby": {
                        "href": "https://developer.apiture.com/errors/errorType1"
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "type": "object",
                  "x-apiture-flattened": true
                }
              ]
            },
            "_id": {
              "description": "The unique identifier for this verification report resource. This is an immutable opaque string.",
              "readOnly": true,
              "type": "string"
            },
            "reportScoringSummary": {
              "title": "Verification Report Summary",
              "description": "Model schema for business verification report summary.",
              "properties": {
                "transactionId": {
                  "description": "The unique transactionId for this verification report used for tracking this verification report",
                  "type": "string"
                },
                "state": {
                  "type": "string",
                  "description": "The state of a verification report.  _passed_ indicates that the Business was successfully verified based upon the supplied information, _failed_ indicates it was not.",
                  "enum": [
                    "passed",
                    "failed"
                  ]
                },
                "businessVerifications": {
                  "description": "A list of business verification scores.",
                  "type": "array",
                  "items": {
                    "title": "Business Verification Score",
                    "description": "An score that summarizes the verification of the input information. This objects contains a score `value` and accompanying `description`.",
                    "properties": {
                      "value": {
                        "description": "The business verification score value",
                        "type": "string"
                      },
                      "description": {
                        "description": "The business verification score description",
                        "type": "string"
                      }
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/businessVerificationScore/v1.0.0/model.json",
                    "x-apiture-namespace": "businessVerifications",
                    "x-apiture-version": "1.0.0",
                    "type": "object",
                    "x-apiture-flattened": true
                  }
                },
                "businessRiskFactors": {
                  "description": "A list of business verification risk factors.",
                  "type": "array",
                  "items": {
                    "title": "Risk Factor",
                    "description": "Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.",
                    "properties": {
                      "riskCode": {
                        "description": "The risk factor risk code",
                        "type": "string"
                      },
                      "description": {
                        "description": "The risk code description",
                        "type": "string"
                      }
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/riskFactor/v1.0.0/model.json",
                    "x-apiture-namespace": "businessVerifications",
                    "x-apiture-version": "1.0.0",
                    "type": "object",
                    "x-apiture-flattened": true
                  }
                },
                "comprehensiveVerificationScores": {
                  "description": "A list of comprehensive business verification scores.",
                  "type": "array",
                  "items": {
                    "title": "Authorized Representative Comprehensive Verification Score",
                    "description": "The comprehensive verification score is a risk verification score for the authorized representative.",
                    "properties": {
                      "inputRepNumber": {
                        "description": "the rep number for the authorized representative",
                        "type": "string"
                      },
                      "score": {
                        "description": "The comprehensive verification score is a risk verification score of the authorized representative",
                        "type": "integer"
                      },
                      "description": {
                        "description": "The description for the CVI value",
                        "type": "string"
                      }
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/comprehensiveVerificationScore/v1.0.0/model.json",
                    "x-apiture-namespace": "businessVerifications",
                    "x-apiture-version": "1.0.0",
                    "type": "object",
                    "x-apiture-flattened": true
                  }
                },
                "authorizedRepresentativeRiskFactors": {
                  "description": "A list of representative business risk factors.",
                  "type": "array",
                  "items": {
                    "title": "Risk Factor",
                    "description": "Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.",
                    "properties": {
                      "riskCode": {
                        "description": "The risk factor risk code",
                        "type": "string"
                      },
                      "description": {
                        "description": "The risk code description",
                        "type": "string"
                      }
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/riskFactor/v1.0.0/model.json",
                    "x-apiture-namespace": "businessVerifications",
                    "x-apiture-version": "1.0.0",
                    "type": "object",
                    "x-apiture-flattened": true
                  }
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/verificationReportScoringSummary/v1.0.0/model.json",
              "x-apiture-namespace": "businessVerifications",
              "x-apiture-version": "1.0.0",
              "type": "object",
              "x-apiture-flattened": true
            },
            "createdAt": {
              "description": "An ISO 8601 UTC time stamp indicating when the verification report was created.",
              "type": "string",
              "format": "date-time"
            },
            "input": {
              "x-apiture-version": "2.0.0",
              "title": "Create Verification Report",
              "description": "Representation used to create a new verification report.",
              "example": {
                "_profile": "https://production.api.apiture.com/schemas/businessVerifications/createVerificationReport/v2.0.0/profile.json",
                "businessName": "ABC EXAMPLE CO.",
                "phone": "555-555-1234",
                "identification": [
                  {
                    "type": "taxId",
                    "value": "12-347894309"
                  }
                ],
                "attributes": {},
                "addresses": [
                  {
                    "addressLine1": "3212 N. 2nd Ave.",
                    "city": "Wilmington",
                    "regionCode": "NC",
                    "postalCode": "28412"
                  }
                ],
                "authorizedSigners": [
                  {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "identification": [
                      {
                        "type": "taxId",
                        "value": "121-34-5431"
                      }
                    ],
                    "birthdate": "1980-12-01",
                    "email": "email@email.com"
                  }
                ]
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/createVerificationReport/v2.0.0/model.json",
              "x-apiture-namespace": "businessVerifications",
              "x-apiture-composition": [
                {
                  "title": "Verification Request Fields",
                  "description": "Common fields of a verification request, used to build other model schemas.",
                  "properties": {
                    "businessName": {
                      "description": "The business's name",
                      "type": "string",
                      "maxLength": 512,
                      "minLength": 1
                    },
                    "alternateBusinessName": {
                      "description": "An alternate name for the business",
                      "type": "string",
                      "maxLength": 512,
                      "minLength": 1
                    },
                    "phone": {
                      "description": "The business's phone",
                      "type": "string",
                      "maxLength": 32,
                      "minLength": 1
                    },
                    "identification": {
                      "title": "Identification Model",
                      "description": "A collection of official identifying information associated with an entity.",
                      "type": "object",
                      "items": {
                        "type": "object",
                        "required": [
                          "type",
                          "value"
                        ],
                        "properties": {
                          "value": {
                            "description": "The value of this form of identification (the tax ID as a string, for example)",
                            "type": "string"
                          },
                          "type": {
                            "description": "The type of this form of identification. For a person, `taxId` is their federal tax ID (such as social security number).  For a business, `taxId` is the  [_Federal Employer Identification Number_](https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers) or FEIN (also known as _Tax Identification Number_ or TIN), and `dunsNumber` is the business' [_Dun & Bradstreet Number_](https://fedgov.dnb.com/webform).",
                            "type": "string",
                            "enum": [
                              "taxId",
                              "dunsNumber"
                            ]
                          }
                        }
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/identificationModel/v1.0.0/model.json",
                      "x-apiture-namespace": "businessVerifications",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    },
                    "authorizedSigners": {
                      "description": "An optional array of authorized signer entities",
                      "type": "array",
                      "items": {
                        "title": "Authorized Signer",
                        "description": "Authorized Signers are primary bank users and co-owners of a business, optionally passed when creating verification reports.",
                        "required": [
                          "firstName",
                          "lastName"
                        ],
                        "properties": {
                          "firstName": {
                            "description": "The authorized signer's first name",
                            "type": "string",
                            "maxLength": 512,
                            "minLength": 1
                          },
                          "lastName": {
                            "description": "The authorized signer's last name",
                            "type": "string",
                            "maxLength": 512,
                            "minLength": 1
                          },
                          "identification": {
                            "title": "Identification Model",
                            "description": "A collection of official identifying information associated with an entity.",
                            "type": "object",
                            "items": {
                              "type": "object",
                              "required": [
                                "type",
                                "value"
                              ],
                              "properties": {
                                "value": {
                                  "description": "The value of this form of identification (the tax ID as a string, for example)",
                                  "type": "string"
                                },
                                "type": {
                                  "description": "The type of this form of identification. For a person, `taxId` is their federal tax ID (such as social security number).  For a business, `taxId` is the  [_Federal Employer Identification Number_](https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers) or FEIN (also known as _Tax Identification Number_ or TIN), and `dunsNumber` is the business' [_Dun & Bradstreet Number_](https://fedgov.dnb.com/webform).",
                                  "type": "string",
                                  "enum": [
                                    "taxId",
                                    "dunsNumber"
                                  ]
                                }
                              }
                            },
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/identificationModel/v1.0.0/model.json",
                            "x-apiture-namespace": "businessVerifications",
                            "x-apiture-version": "1.0.0",
                            "properties": {},
                            "x-apiture-flattened": true
                          },
                          "birthdate": {
                            "description": "The authorized signer's birth date in `yyyy-mm-dd` format.",
                            "type": "string",
                            "format": "date",
                            "pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$",
                            "maxLength": 10,
                            "minLength": 10
                          },
                          "email": {
                            "description": "The authorized signer's email address",
                            "type": "string",
                            "maxLength": 512,
                            "minLength": 1
                          }
                        },
                        "example": {
                          "firstName": "Jane",
                          "lastName": "Doe",
                          "identification": [
                            {
                              "type": "taxId",
                              "value": "121-34-5431"
                            }
                          ],
                          "birthdat>": "1980-12-01",
                          "email": "email@email.com"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/authorizedSigner/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "type": "object",
                        "x-apiture-flattened": true
                      }
                    },
                    "addresses": {
                      "description": "An array of postal mailing addresses for this contact.",
                      "type": "array",
                      "items": {
                        "title": "Address",
                        "description": "A postal address.",
                        "type": "object",
                        "required": [
                          "type"
                        ],
                        "properties": {
                          "type": {
                            "description": "The type of this address.",
                            "allOf": [
                              {
                                "title": "Address Type",
                                "description": "The type of a postal address.\n\n**Warning**: the `enum` list will be removed in a future release. and the values defined at runtime via the `addressType` label group in the response from the [`getLabels`](#op-getLabels) operation.",
                                "type": "object",
                                "x-apiture-choice": "addressType",
                                "enum": [
                                  "unknown",
                                  "home",
                                  "prior",
                                  "work",
                                  "school",
                                  "mailing",
                                  "vacation",
                                  "shipping",
                                  "billing",
                                  "headquarters",
                                  "commercial",
                                  "site",
                                  "property",
                                  "other",
                                  "notApplicable"
                                ],
                                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/contacts/addressType/v1.0.0/model.json",
                                "x-apiture-namespace": "contacts",
                                "x-apiture-version": "1.0.0",
                                "properties": {},
                                "x-apiture-flattened": true
                              }
                            ]
                          },
                          "label": {
                            "description": "A text label, suitable for presentation to the end user. This is derived from `type` or from `otherType` if `type` is `other`",
                            "type": "string",
                            "readOnly": true,
                            "minLength": 4,
                            "maxLength": 32
                          },
                          "otherType": {
                            "description": "The actual address type if `type` is `other`.",
                            "minLength": 4,
                            "maxLength": 32,
                            "type": "string"
                          },
                          "addressLine1": {
                            "description": "The first street address line of the address, normally a house number and street name.",
                            "type": "string",
                            "minLength": 4,
                            "maxLength": 128
                          },
                          "addressLine2": {
                            "description": "The optional second street address line of the address.",
                            "type": "string",
                            "maxLength": 128
                          },
                          "city": {
                            "description": "The name of the city or municipality.",
                            "type": "string",
                            "minLength": 2,
                            "maxLength": 128
                          },
                          "regionCode": {
                            "description": "The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.",
                            "type": "string",
                            "example": "NC",
                            "minLength": 2,
                            "maxLength": 2,
                            "pattern": "^[a-zA-Z]{2}$"
                          },
                          "postalCode": {
                            "description": "The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.",
                            "type": "string",
                            "example": "28401-5405",
                            "minLength": 5,
                            "maxLength": 10,
                            "pattern": "^[0-9]{5}(?:-[0-9]{4})?$"
                          },
                          "countryCode": {
                            "description": "The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This is normalized to uppercase.",
                            "type": "string",
                            "minLength": 2,
                            "maxLength": 2,
                            "pattern": "^[a-zA-Z]{2}$"
                          },
                          "_id": {
                            "description": "An identifier for this address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all addresses within the `addresses` array.",
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 8,
                            "example": "ha5",
                            "pattern": "^[-a-zA-Z0-9_]{1,8}$"
                          }
                        },
                        "example": {
                          "_id": "ha5",
                          "type": "home",
                          "addressLine1": "555 N Front Street",
                          "addressLine2": "Suite 5555",
                          "city": "Wilmington",
                          "regionCode": "NC",
                          "postalCode": "28401-5405",
                          "countryCode": "US"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/contacts/address/v1.0.0/model.json",
                        "x-apiture-namespace": "contacts",
                        "x-apiture-version": "1.0.0",
                        "x-apiture-flattened": true
                      }
                    },
                    "attributes": {
                      "description": "An optional map of name/value pairs which provide additional metadata about the verification report.",
                      "allOf": [
                        {
                          "x-apiture-version": "2.0.0",
                          "title": "Attributes",
                          "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                          "type": "object",
                          "x-apiture-key": "attributeName",
                          "additionalProperties": {
                            "x-apiture-version": "2.0.0",
                            "title": "Attribute Value",
                            "description": "The data associated with this attribute.",
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "properties": {},
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "properties": {},
                          "x-apiture-flattened": true
                        }
                      ]
                    }
                  },
                  "example": {
                    "businessName": "ABC EXAMPLE CO.",
                    "phone": "555-555-1234",
                    "identification": [
                      {
                        "type": "taxId",
                        "value": "12-347894309"
                      }
                    ],
                    "attributes": {},
                    "addresses": [
                      {
                        "addressLine1": "3212 N. 2nd Ave.",
                        "city": "Wilmington",
                        "regionCode": "NC",
                        "postalCode": "28412"
                      }
                    ],
                    "authorizedSigners": [
                      {
                        "firstName": "Jane",
                        "lastName": "Doe",
                        "identification": [
                          {
                            "type": "taxId",
                            "value": "121-34-5431"
                          }
                        ],
                        "birthdate": "1980-12-01",
                        "email": "email@email.com"
                      }
                    ]
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/verificationRequestFields/v1.0.0/model.json",
                  "x-apiture-namespace": "businessVerifications",
                  "x-apiture-version": "1.0.0",
                  "type": "object",
                  "x-apiture-flattened": true
                },
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Abstract Request",
                  "description": "An abstract schema used to define other request-only schemas. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation, minus the `_error` defined in `abstractResource`.",
                  "properties": {
                    "_links": {
                      "title": "Links",
                      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                      "type": "object",
                      "x-apiture-key": "linkRelationName",
                      "additionalProperties": {
                        "x-apiture-version": "1.0.0",
                        "title": "Link",
                        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                        "required": [
                          "href"
                        ],
                        "properties": {
                          "href": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI or URI template for the resource/operation this link refers to."
                          },
                          "type": {
                            "type": "string",
                            "description": "The media type for the resource."
                          },
                          "templated": {
                            "type": "boolean",
                            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                          },
                          "title": {
                            "type": "string",
                            "description": "An optional human-readable localized title for the link."
                          },
                          "deprecation": {
                            "type": "string",
                            "format": "uri",
                            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                          },
                          "profile": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                          }
                        },
                        "example": {
                          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                          "title": "Applicant"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    },
                    "_embedded": {
                      "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                      "type": "object"
                    },
                    "_profile": {
                      "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                      "type": "string",
                      "format": "uri"
                    }
                  },
                  "example": {
                    "_profile": "{uri of resource profile.json}",
                    "_links": {
                      "self": {
                        "href": "{uri of current resource}"
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "type": "object",
                  "x-apiture-flattened": true
                }
              ],
              "type": "object",
              "properties": {
                "businessName": {
                  "description": "The business's name",
                  "type": "string",
                  "maxLength": 512,
                  "minLength": 1
                },
                "alternateBusinessName": {
                  "description": "An alternate name for the business",
                  "type": "string",
                  "maxLength": 512,
                  "minLength": 1
                },
                "phone": {
                  "description": "The business's phone",
                  "type": "string",
                  "maxLength": 32,
                  "minLength": 1
                },
                "identification": {
                  "title": "Identification Model",
                  "description": "A collection of official identifying information associated with an entity.",
                  "type": "object",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "description": "The value of this form of identification (the tax ID as a string, for example)",
                        "type": "string"
                      },
                      "type": {
                        "description": "The type of this form of identification. For a person, `taxId` is their federal tax ID (such as social security number).  For a business, `taxId` is the  [_Federal Employer Identification Number_](https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers) or FEIN (also known as _Tax Identification Number_ or TIN), and `dunsNumber` is the business' [_Dun & Bradstreet Number_](https://fedgov.dnb.com/webform).",
                        "type": "string",
                        "enum": [
                          "taxId",
                          "dunsNumber"
                        ]
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/identificationModel/v1.0.0/model.json",
                  "x-apiture-namespace": "businessVerifications",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                },
                "authorizedSigners": {
                  "description": "An optional array of authorized signer entities",
                  "type": "array",
                  "items": {
                    "title": "Authorized Signer",
                    "description": "Authorized Signers are primary bank users and co-owners of a business, optionally passed when creating verification reports.",
                    "required": [
                      "firstName",
                      "lastName"
                    ],
                    "properties": {
                      "firstName": {
                        "description": "The authorized signer's first name",
                        "type": "string",
                        "maxLength": 512,
                        "minLength": 1
                      },
                      "lastName": {
                        "description": "The authorized signer's last name",
                        "type": "string",
                        "maxLength": 512,
                        "minLength": 1
                      },
                      "identification": {
                        "title": "Identification Model",
                        "description": "A collection of official identifying information associated with an entity.",
                        "type": "object",
                        "items": {
                          "type": "object",
                          "required": [
                            "type",
                            "value"
                          ],
                          "properties": {
                            "value": {
                              "description": "The value of this form of identification (the tax ID as a string, for example)",
                              "type": "string"
                            },
                            "type": {
                              "description": "The type of this form of identification. For a person, `taxId` is their federal tax ID (such as social security number).  For a business, `taxId` is the  [_Federal Employer Identification Number_](https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers) or FEIN (also known as _Tax Identification Number_ or TIN), and `dunsNumber` is the business' [_Dun & Bradstreet Number_](https://fedgov.dnb.com/webform).",
                              "type": "string",
                              "enum": [
                                "taxId",
                                "dunsNumber"
                              ]
                            }
                          }
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/identificationModel/v1.0.0/model.json",
                        "x-apiture-namespace": "businessVerifications",
                        "x-apiture-version": "1.0.0",
                        "properties": {},
                        "x-apiture-flattened": true
                      },
                      "birthdate": {
                        "description": "The authorized signer's birth date in `yyyy-mm-dd` format.",
                        "type": "string",
                        "format": "date",
                        "pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$",
                        "maxLength": 10,
                        "minLength": 10
                      },
                      "email": {
                        "description": "The authorized signer's email address",
                        "type": "string",
                        "maxLength": 512,
                        "minLength": 1
                      }
                    },
                    "example": {
                      "firstName": "Jane",
                      "lastName": "Doe",
                      "identification": [
                        {
                          "type": "taxId",
                          "value": "121-34-5431"
                        }
                      ],
                      "birthdat>": "1980-12-01",
                      "email": "email@email.com"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/businessVerifications/authorizedSigner/v1.0.0/model.json",
                    "x-apiture-namespace": "businessVerifications",
                    "x-apiture-version": "1.0.0",
                    "type": "object",
                    "x-apiture-flattened": true
                  }
                },
                "addresses": {
                  "description": "An array of postal mailing addresses for this contact.",
                  "type": "array",
                  "items": {
                    "title": "Address",
                    "description": "A postal address.",
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "description": "The type of this address.",
                        "allOf": [
                          {
                            "title": "Address Type",
                            "description": "The type of a postal address.\n\n**Warning**: the `enum` list will be removed in a future release. and the values defined at runtime via the `addressType` label group in the response from the [`getLabels`](#op-getLabels) operation.",
                            "type": "object",
                            "x-apiture-choice": "addressType",
                            "enum": [
                              "unknown",
                              "home",
                              "prior",
                              "work",
                              "school",
                              "mailing",
                              "vacation",
                              "shipping",
                              "billing",
                              "headquarters",
                              "commercial",
                              "site",
                              "property",
                              "other",
                              "notApplicable"
                            ],
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/contacts/addressType/v1.0.0/model.json",
                            "x-apiture-namespace": "contacts",
                            "x-apiture-version": "1.0.0",
                            "properties": {},
                            "x-apiture-flattened": true
                          }
                        ]
                      },
                      "label": {
                        "description": "A text label, suitable for presentation to the end user. This is derived from `type` or from `otherType` if `type` is `other`",
                        "type": "string",
                        "readOnly": true,
                        "minLength": 4,
                        "maxLength": 32
                      },
                      "otherType": {
                        "description": "The actual address type if `type` is `other`.",
                        "minLength": 4,
                        "maxLength": 32,
                        "type": "string"
                      },
                      "addressLine1": {
                        "description": "The first street address line of the address, normally a house number and street name.",
                        "type": "string",
                        "minLength": 4,
                        "maxLength": 128
                      },
                      "addressLine2": {
                        "description": "The optional second street address line of the address.",
                        "type": "string",
                        "maxLength": 128
                      },
                      "city": {
                        "description": "The name of the city or municipality.",
                        "type": "string",
                        "minLength": 2,
                        "maxLength": 128
                      },
                      "regionCode": {
                        "description": "The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.",
                        "type": "string",
                        "example": "NC",
                        "minLength": 2,
                        "maxLength": 2,
                        "pattern": "^[a-zA-Z]{2}$"
                      },
                      "postalCode": {
                        "description": "The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.",
                        "type": "string",
                        "example": "28401-5405",
                        "minLength": 5,
                        "maxLength": 10,
                        "pattern": "^[0-9]{5}(?:-[0-9]{4})?$"
                      },
                      "countryCode": {
                        "description": "The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This is normalized to uppercase.",
                        "type": "string",
                        "minLength": 2,
                        "maxLength": 2,
                        "pattern": "^[a-zA-Z]{2}$"
                      },
                      "_id": {
                        "description": "An identifier for this address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all addresses within the `addresses` array.",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 8,
                        "example": "ha5",
                        "pattern": "^[-a-zA-Z0-9_]{1,8}$"
                      }
                    },
                    "example": {
                      "_id": "ha5",
                      "type": "home",
                      "addressLine1": "555 N Front Street",
                      "addressLine2": "Suite 5555",
                      "city": "Wilmington",
                      "regionCode": "NC",
                      "postalCode": "28401-5405",
                      "countryCode": "US"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/contacts/address/v1.0.0/model.json",
                    "x-apiture-namespace": "contacts",
                    "x-apiture-version": "1.0.0",
                    "x-apiture-flattened": true
                  }
                },
                "attributes": {
                  "description": "An optional map of name/value pairs which provide additional metadata about the verification report.",
                  "allOf": [
                    {
                      "x-apiture-version": "2.0.0",
                      "title": "Attributes",
                      "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                      "type": "object",
                      "x-apiture-key": "attributeName",
                      "additionalProperties": {
                        "x-apiture-version": "2.0.0",
                        "title": "Attribute Value",
                        "description": "The data associated with this attribute.",
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "properties": {},
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "properties": {},
                      "x-apiture-flattened": true
                    }
                  ]
                },
                "_links": {
                  "title": "Links",
                  "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                  "type": "object",
                  "x-apiture-key": "linkRelationName",
                  "additionalProperties": {
                    "x-apiture-version": "1.0.0",
                    "title": "Link",
                    "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI or URI template for the resource/operation this link refers to."
                      },
                      "type": {
                        "type": "string",
                        "description": "The media type for the resource."
                      },
                      "templated": {
                        "type": "boolean",
                        "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                      },
                      "title": {
                        "type": "string",
                        "description": "An optional human-readable localized title for the link."
                      },
                      "deprecation": {
                        "type": "string",
                        "format": "uri",
                        "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                      },
                      "profile": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                      }
                    },
                    "example": {
                      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                      "title": "Applicant"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                },
                "_embedded": {
                  "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                  "type": "object"
                },
                "_profile": {
                  "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                  "type": "string",
                  "format": "uri"
                }
              },
              "x-apiture-flattened": true
            },
            "reportResults": {
              "description": "The raw verification report results",
              "type": "object"
            }
          },
          "x-apiture-flattened": true
        }
      ]
    },
    "state": {
      "description": "The state of the external account.",
      "type": "string",
      "readOnly": true,
      "allOf": [
        {
          "x-apiture-version": "1.0.0",
          "title": "External Account State",
          "description": "The state of an external (linked) banking account. This field is immutable and derived.\n\n  * **`pending`** : A new external account that has not been verified\n  * **`verifying`** : A new account that is being verified. This state only\n  applies to _external_ accounts.\n  * **`failed`** : A external account which has failed account verification.\n  * **`active`** : An account which is active and available for use\n  and for making new transactions.\n  * **`inactive`** : An account which is marked inactive and\n  not available for new transactions. Inactive accounts\n  may be changed back to active.\n  * **`frozen`** : An account which is frozen and not eligible\n  for new transactions. This is typically the result of\n  suspicious activity or fraud detection. The user must contact\n  their financial institution to unfreeze the account (by changing\n  the state back to `active`) or the financial institution\n  may opt to close the account.\n  * **`closed`** : An account that is closed and removed from use.\n  Closed accounts are not eligible for transactions or to become active.\n  Such accounts are retained for historical purposes because some\n  transactions may refer to it. Users do not see closed accounts\n  when they view their accounts.\n  * **`underReview`** : A new account that is being under review. This state only\n  applies to _external_ accounts.\n\nTo change the state of an account, `POST` the account ID to the corresponding resource endpoints, using the corresponding link on the account resource. To activate an account, use the `apiture:activate` link to `POST` to `/accounts/activeAccounts`. To deactivate an account, use the `apiture:deactivate` link to `POST` to `/accounts/inactiveAccounts`. To freeze an account, use the `apiture:freeze` link to `POST` to `/accounts/frozenAccounts`. To close an account, use the `apiture:close` link to `POST` to `/accounts/closedAccounts`. To under review an account, use the `apiture:review` link to `POST` to `/accounts/externalAccountsUnderReview`.",
          "type": "object",
          "enum": [
            "pending",
            "verifying",
            "failed",
            "active",
            "inactive",
            "frozen",
            "closed",
            "underReview"
          ],
          "x-apiture-enum": "externalAccountState",
          "example": "active",
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/accounts/externalAccountState/v1.0.0/model.json",
          "x-apiture-namespace": "accounts",
          "properties": {},
          "x-apiture-flattened": true
        }
      ]
    }
  },
  "x-apiture-version": "1.0.0",
  "x-apiture-composition": [
    {
      "title": "Transfer Account",
      "description": "Summary properties of the source and target account for a transfer.",
      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/transfers/transferAccount/v1.0.0/model.json",
      "x-apiture-namespace": "transfers",
      "x-apiture-version": "1.0.0",
      "x-apiture-composition": [
        {
          "x-apiture-version": "2.0.0",
          "title": "Abstract Resource",
          "description": "An abstract schema used to define other schemas for request and response bodies. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation. This model contains hypermedia `_links`, and either optional domain object data with `_profile` and optional `_embedded` objects, or an `_error` object. In responses, if the operation was successful, this object will not include the `_error`, but if the operation was a 4xx or 5xx error, this object will not include `_embedded` or any data fields, only `_error` and optionally `_links`.",
          "example": {
            "_profile": "{uri of resource profile.json}",
            "_links": {
              "self": {
                "href": "{uri of current resource}"
              }
            }
          },
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/model.json",
          "x-apiture-namespace": "common",
          "x-apiture-composition": [
            {
              "x-apiture-version": "2.0.0",
              "title": "Abstract Request",
              "description": "An abstract schema used to define other request-only schemas. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation, minus the `_error` defined in `abstractResource`.",
              "properties": {
                "_links": {
                  "title": "Links",
                  "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                  "type": "object",
                  "x-apiture-key": "linkRelationName",
                  "additionalProperties": {
                    "x-apiture-version": "1.0.0",
                    "title": "Link",
                    "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI or URI template for the resource/operation this link refers to."
                      },
                      "type": {
                        "type": "string",
                        "description": "The media type for the resource."
                      },
                      "templated": {
                        "type": "boolean",
                        "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                      },
                      "title": {
                        "type": "string",
                        "description": "An optional human-readable localized title for the link."
                      },
                      "deprecation": {
                        "type": "string",
                        "format": "uri",
                        "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                      },
                      "profile": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                      }
                    },
                    "example": {
                      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                      "title": "Applicant"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                },
                "_embedded": {
                  "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
                  "type": "object"
                },
                "_profile": {
                  "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
                  "type": "string",
                  "format": "uri"
                }
              },
              "example": {
                "_profile": "{uri of resource profile.json}",
                "_links": {
                  "self": {
                    "href": "{uri of current resource}"
                  }
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/model.json",
              "x-apiture-namespace": "common",
              "type": "object",
              "x-apiture-flattened": true
            },
            {
              "properties": [
                "_error"
              ]
            }
          ],
          "type": "object",
          "properties": {
            "_links": {
              "title": "Links",
              "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
              "type": "object",
              "x-apiture-key": "linkRelationName",
              "additionalProperties": {
                "x-apiture-version": "1.0.0",
                "title": "Link",
                "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                "required": [
                  "href"
                ],
                "properties": {
                  "href": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI or URI template for the resource/operation this link refers to."
                  },
                  "type": {
                    "type": "string",
                    "description": "The media type for the resource."
                  },
                  "templated": {
                    "type": "boolean",
                    "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                  },
                  "title": {
                    "type": "string",
                    "description": "An optional human-readable localized title for the link."
                  },
                  "deprecation": {
                    "type": "string",
                    "format": "uri",
                    "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                  },
                  "profile": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                  }
                },
                "example": {
                  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                  "title": "Applicant"
                },
                "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                "x-apiture-namespace": "common",
                "type": "object",
                "x-apiture-flattened": true
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
              "x-apiture-namespace": "common",
              "x-apiture-version": "1.0.0",
              "properties": {},
              "x-apiture-flattened": true
            },
            "_embedded": {
              "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
              "type": "object"
            },
            "_profile": {
              "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
              "type": "string",
              "format": "uri"
            },
            "_error": {
              "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
              "type": "object",
              "allOf": [
                {
                  "x-apiture-version": "2.0.0",
                  "title": "Error",
                  "description": "Describes an error in an API request or in a service called via the API.",
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "A localized message string describing the error condition."
                    },
                    "_id": {
                      "description": "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.",
                      "readOnly": true,
                      "type": "string"
                    },
                    "statusCode": {
                      "description": "The HTTP status code associate with this error.",
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 599,
                      "example": 422
                    },
                    "type": {
                      "type": "string",
                      "description": "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": {
                      "type": "string",
                      "format": "date-time",
                      "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                      "example": "2018-02-02T03:37:15.375Z"
                    },
                    "attributes": {
                      "description": "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`.",
                      "allOf": [
                        {
                          "x-apiture-version": "2.0.0",
                          "title": "Attributes",
                          "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                          "type": "object",
                          "x-apiture-key": "attributeName",
                          "additionalProperties": {
                            "x-apiture-version": "2.0.0",
                            "title": "Attribute Value",
                            "description": "The data associated with this attribute.",
                            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                            "x-apiture-namespace": "common",
                            "type": "object",
                            "properties": {},
                            "x-apiture-flattened": true
                          },
                          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                          "x-apiture-namespace": "common",
                          "properties": {},
                          "x-apiture-flattened": true
                        }
                      ]
                    },
                    "remediation": {
                      "type": "string",
                      "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                    },
                    "errors": {
                      "description": "An optional array of nested error objects. This property is not always present.",
                      "type": "array",
                      "items": "[Circular]"
                    },
                    "_links": {
                      "title": "Links",
                      "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                      "type": "object",
                      "x-apiture-key": "linkRelationName",
                      "additionalProperties": {
                        "x-apiture-version": "1.0.0",
                        "title": "Link",
                        "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                        "required": [
                          "href"
                        ],
                        "properties": {
                          "href": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI or URI template for the resource/operation this link refers to."
                          },
                          "type": {
                            "type": "string",
                            "description": "The media type for the resource."
                          },
                          "templated": {
                            "type": "boolean",
                            "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                          },
                          "title": {
                            "type": "string",
                            "description": "An optional human-readable localized title for the link."
                          },
                          "deprecation": {
                            "type": "string",
                            "format": "uri",
                            "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                          },
                          "profile": {
                            "type": "string",
                            "format": "uri",
                            "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                          }
                        },
                        "example": {
                          "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                          "title": "Applicant"
                        },
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "x-apiture-version": "1.0.0",
                      "properties": {},
                      "x-apiture-flattened": true
                    }
                  },
                  "example": {
                    "_id": "2eae46e1575c0a7b0115a4b3",
                    "message": "Descriptive error message...",
                    "statusCode": 422,
                    "type": "errorType1",
                    "remediation": "Remediation string...",
                    "occurredAt": "2018-01-25T05:50:52.375Z",
                    "errors": [
                      {
                        "_id": "ccdbe2c5c938a230667b3827",
                        "message": "An optional embedded error"
                      },
                      {
                        "_id": "dbe9088dcfe2460f229338a3",
                        "message": "Another optional embedded error"
                      }
                    ],
                    "_links": {
                      "describedby": {
                        "href": "https://developer.apiture.com/errors/errorType1"
                      }
                    }
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "type": "object",
                  "x-apiture-flattened": true
                }
              ]
            }
          },
          "x-apiture-flattened": true
        },
        {
          "properties": [
            "accountTitle",
            "title",
            "institutionName",
            "routingNumber",
            "accountNumbers",
            "ifxType"
          ]
        }
      ],
      "type": "object",
      "properties": {
        "_links": {
          "title": "Links",
          "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
          "type": "object",
          "x-apiture-key": "linkRelationName",
          "additionalProperties": {
            "x-apiture-version": "1.0.0",
            "title": "Link",
            "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "type": "string",
                "format": "uri",
                "description": "The URI or URI template for the resource/operation this link refers to."
              },
              "type": {
                "type": "string",
                "description": "The media type for the resource."
              },
              "templated": {
                "type": "boolean",
                "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
              },
              "title": {
                "type": "string",
                "description": "An optional human-readable localized title for the link."
              },
              "deprecation": {
                "type": "string",
                "format": "uri",
                "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
              },
              "profile": {
                "type": "string",
                "format": "uri",
                "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
              }
            },
            "example": {
              "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
              "title": "Applicant"
            },
            "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
            "x-apiture-namespace": "common",
            "type": "object",
            "x-apiture-flattened": true
          },
          "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
          "x-apiture-namespace": "common",
          "x-apiture-version": "1.0.0",
          "properties": {},
          "x-apiture-flattened": true
        },
        "_embedded": {
          "description": "An optional map of nested resources, mapping each nested resource name to a nested resource representation.",
          "type": "object"
        },
        "_profile": {
          "description": "The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.",
          "type": "string",
          "format": "uri"
        },
        "_error": {
          "description": "An object which describes an error. This value is omitted if the operation succeeded without error.",
          "type": "object",
          "allOf": [
            {
              "x-apiture-version": "2.0.0",
              "title": "Error",
              "description": "Describes an error in an API request or in a service called via the API.",
              "required": [
                "message"
              ],
              "properties": {
                "message": {
                  "type": "string",
                  "description": "A localized message string describing the error condition."
                },
                "_id": {
                  "description": "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.",
                  "readOnly": true,
                  "type": "string"
                },
                "statusCode": {
                  "description": "The HTTP status code associate with this error.",
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 599,
                  "example": 422
                },
                "type": {
                  "type": "string",
                  "description": "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": {
                  "type": "string",
                  "format": "date-time",
                  "description": "An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.",
                  "example": "2018-02-02T03:37:15.375Z"
                },
                "attributes": {
                  "description": "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`.",
                  "allOf": [
                    {
                      "x-apiture-version": "2.0.0",
                      "title": "Attributes",
                      "description": "An optional map of name/value pairs which contains additional dynamic data about the resource.",
                      "type": "object",
                      "x-apiture-key": "attributeName",
                      "additionalProperties": {
                        "x-apiture-version": "2.0.0",
                        "title": "Attribute Value",
                        "description": "The data associated with this attribute.",
                        "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json",
                        "x-apiture-namespace": "common",
                        "type": "object",
                        "properties": {},
                        "x-apiture-flattened": true
                      },
                      "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json",
                      "x-apiture-namespace": "common",
                      "properties": {},
                      "x-apiture-flattened": true
                    }
                  ]
                },
                "remediation": {
                  "type": "string",
                  "description": "An optional localized string which provides hints for how the user or client can resolve the error."
                },
                "errors": {
                  "description": "An optional array of nested error objects. This property is not always present.",
                  "type": "array",
                  "items": "[Circular]"
                },
                "_links": {
                  "title": "Links",
                  "description": "An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.",
                  "type": "object",
                  "x-apiture-key": "linkRelationName",
                  "additionalProperties": {
                    "x-apiture-version": "1.0.0",
                    "title": "Link",
                    "description": "Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property.",
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI or URI template for the resource/operation this link refers to."
                      },
                      "type": {
                        "type": "string",
                        "description": "The media type for the resource."
                      },
                      "templated": {
                        "type": "boolean",
                        "description": "If true, the link's href is a [URI template](https://tools.ietf.org/html/rfc6570)."
                      },
                      "title": {
                        "type": "string",
                        "description": "An optional human-readable localized title for the link."
                      },
                      "deprecation": {
                        "type": "string",
                        "format": "uri",
                        "description": "If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation."
                      },
                      "profile": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URI of a profile document, a JSON document which describes the target resource/operation."
                      }
                    },
                    "example": {
                      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
                      "title": "Applicant"
                    },
                    "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json",
                    "x-apiture-namespace": "common",
                    "type": "object",
                    "x-apiture-flattened": true
                  },
                  "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json",
                  "x-apiture-namespace": "common",
                  "x-apiture-version": "1.0.0",
                  "properties": {},
                  "x-apiture-flattened": true
                }
              },
              "example": {
                "_id": "2eae46e1575c0a7b0115a4b3",
                "message": "Descriptive error message...",
                "statusCode": 422,
                "type": "errorType1",
                "remediation": "Remediation string...",
                "occurredAt": "2018-01-25T05:50:52.375Z",
                "errors": [
                  {
                    "_id": "ccdbe2c5c938a230667b3827",
                    "message": "An optional embedded error"
                  },
                  {
                    "_id": "dbe9088dcfe2460f229338a3",
                    "message": "Another optional embedded error"
                  }
                ],
                "_links": {
                  "describedby": {
                    "href": "https://developer.apiture.com/errors/errorType1"
                  }
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json",
              "x-apiture-namespace": "common",
              "type": "object",
              "x-apiture-flattened": true
            }
          ]
        },
        "accountTitle": {
          "description": "The title of the account. Traditionally, this is the name of the account holder. This field is deprecated and will be removed in a future release; use `title` instead.",
          "maxLength": 512,
          "type": "string",
          "example": "John Smith"
        },
        "title": {
          "description": "The title of the account. Traditionally, this is the name of the account holder.",
          "maxLength": 512,
          "type": "string",
          "example": "John Smith"
        },
        "institutionName": {
          "description": "The name of the financial institution.",
          "type": "string",
          "minLength": 2,
          "maxLength": 128,
          "example": "3rd Party Bank",
          "readOnly": true
        },
        "routingNumber": {
          "description": "The account routing number which identifies the financial institution. The full routing number and full account number are required to fully identify the account.",
          "type": "string",
          "minLength": 9,
          "maxLength": 9,
          "example": "021000021",
          "readOnly": true
        },
        "accountNumbers": {
          "description": "The account numbers for this account",
          "type": "object",
          "allOf": [
            {
              "title": "Account Numbers",
              "description": "Different representations of an account number.",
              "properties": {
                "masked": {
                  "description": "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.",
                  "type": "string",
                  "minLength": 8,
                  "maxLength": 32,
                  "readOnly": true,
                  "example": "*************3210"
                },
                "full": {
                  "description": "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.",
                  "type": "string",
                  "minLength": 4,
                  "maxLength": 17,
                  "example": "9876543210",
                  "readOnly": true
                }
              },
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/common/accountNumbers/v1.0.0/model.json",
              "x-apiture-namespace": "common",
              "x-apiture-version": "1.0.0",
              "type": "object",
              "x-apiture-flattened": true
            }
          ],
          "readOnly": true
        },
        "ifxType": {
          "description": "A code which identifies the product type. This is one of the [IFX AcctType](https://ifxforum.org) values.",
          "allOf": [
            {
              "title": "IFX Account Type (v1.0.0)",
              "description": "A code which identifies the product type. This is one of the [IFX AcctType](https://ifxforum.org) values. Labels and descriptions for the enumeration values are in the `ifxType` key in the response of the `getLabels` operation.\n\n<strong><code>ifxType</code></strong> strings may have one of the following\n[enumerated values](https://developer.apiture.com/concepts/label-groups#enumerations) values\n(described by the named ifxType)\n\n<table>\n<tr>\n  <th>Value</th><th>Description</th>\n</tr>\n\nThese enumeration values are further described by the [label group](https://developer.apiture.com/concepts/label-groups)\nnamed `ifxType` in the response from the [`getLabels`](#op-getLabels) operation.\n\n<tr>\n    <td><strong><code>CCA</code></strong></td><td>Credit card account</td>\n    </tr>\n<tr>\n    <td><strong><code>CDA</code></strong></td><td>Certificate of deposit account (CD)</td>\n    </tr>\n<tr>\n    <td><strong><code>CLA</code></strong></td><td>Commercial loan account</td>\n    </tr>\n<tr>\n    <td><strong><code>CMA</code></strong></td><td>Cash management account</td>\n    </tr>\n<tr>\n    <td><strong><code>DDA</code></strong></td><td>Demand deposit account</td>\n    </tr>\n<tr>\n    <td><strong><code>EQU</code></strong></td><td>Home equity loan</td>\n    </tr>\n<tr>\n    <td><strong><code>GLA</code></strong></td><td>General ledger account</td>\n    </tr>\n<tr>\n    <td><strong><code>ILA</code></strong></td><td>Installment loan account</td>\n    </tr>\n<tr>\n    <td><strong><code>INV</code></strong></td><td>Investment account</td>\n    </tr>\n<tr>\n    <td><strong><code>IRA</code></strong></td><td>Individual retirement account</td>\n    </tr>\n<tr>\n    <td><strong><code>IRL</code></strong></td><td>Accounts held in Ireland</td>\n    </tr>\n<tr>\n    <td><strong><code>LOC</code></strong></td><td>Consumer line of credit</td>\n    </tr>\n<tr>\n    <td><strong><code>MLA</code></strong></td><td>Military Lending Account: Credit facility held by former US service member</td>\n    </tr>\n<tr>\n    <td><strong><code>MMA</code></strong></td><td>Money market account</td>\n    </tr>\n<tr>\n    <td><strong><code>PBA</code></strong></td><td>Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.</td>\n    </tr>\n<tr>\n    <td><strong><code>PPA</code></strong></td><td>Private pension administrator</td>\n    </tr>\n<tr>\n    <td><strong><code>RWD</code></strong></td><td>Reward accounts</td>\n    </tr>\n<tr>\n    <td><strong><code>SDA</code></strong></td><td>Savings deposit account</td>\n    </tr>\n</table>\n\n\nThis schema is version `v1.0.0`.",
              "x-apiture-enum": "ifxType",
              "type": "object",
              "enum": [
                "CCA",
                "CDA",
                "CLA",
                "CMA",
                "DDA",
                "EQU",
                "GLA",
                "ILA",
                "INV",
                "IRA",
                "IRL",
                "LOC",
                "MLA",
                "MMA",
                "PBA",
                "PPA",
                "RWD",
                "SDA"
              ],
              "x-apiture-version": "1.0.0",
              "x-apiture-resolved-from": "https://production.api.apiture.com/schemas/products/ifxType/v1.0.0/model.json",
              "x-apiture-namespace": "products",
              "properties": {},
              "x-apiture-flattened": true
            }
          ],
          "readOnly": true
        }
      },
      "x-apiture-flattened": true
    }
  ],
  "x-apiture-flattened": true
}

Verified Transfer Account (v1.0.0)

Details of the account, possibly an external account, used to fund the new account.

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.
_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.
accountTitle	string The title of the account. Traditionally, this is the name of the account holder. This field is deprecated and will be removed in a future release; use title instead. maxLength: 512
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
ifxType	ifxType A code which identifies the product type. This is one of the IFX AcctType values. read-only
verificationReport	verificationReport If this funding account is a new external account, this is an account verification report from an external account verification provider. It contains a pass/fail result based on risk factors. This property does not exist if the account is an internal account at this financial institution, or if this account is an external account that the user verified before starting this application.
state	externalAccountState The state of the external account. read-only

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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

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

configuration

{
  "_links": {
    "self": {
      "href": "/configurations/configurations/"
    },
    "apiture:groups": {
      "href": "/configurations/configurations/groups"
    }
  }
}

Configuration

Represents the configuration for various services.

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://production.api.apiture.com/schemas/configurations/configurationGroups/v2.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Configuration Group Collection

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	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.
» 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 may 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.

configurationGroup

{
  "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": "17:30:00"
  }
}

Configuration Group

Represents a configuration group.

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.
_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 which follow 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.
values	configurationValues The data values associated with this configuration group: the group'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": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow 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

Name	Description
additionalProperties	configurationSchemaValue The data associated with this configuration schema.

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Configuration Values

The data values associated with this configuration group: the group'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

Name	Description
additionalProperties	configurationValue The data associated with this configuration.

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
  "_links": {}
}

API Root

A HAL response, with hypermedia _links for the top-level resources and operations in 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.
_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. read-only
name	string This API's name.
apiVersion	string This API's version.

money

{
  "value": "3456.78",
  "currency": "str"
}

Money

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. Note: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3 maxLength: 3

attributes

{
  "property1": {},
  "property2": {}
}

Attributes

An optional map of name/value pairs which contains additional dynamic data about the resource.

Properties

Name	Description
additionalProperties	attributeValue The data associated with this attribute.

summaryProduct

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "revision": "2018-04-25T07:56:46.375Z",
  "_embedded": {},
  "ifxType": "DDA"
}

Product Summary (v1.0.0)

Summary representation of a product resource in products 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. This representation omits the attributes of the full representation.

This schema is version v1.0.0.

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.
_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.
state	prodState The state of this product or product type. New resources are pending by default and must be activated before they may be used. The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.
name	string The name of this product. minLength: 1 maxLength: 128
label	string The text label for this product. This field may be localized. minLength: 1 maxLength: 128
description	string(markdown) A fuller description of this product. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text. minLength: 1 maxLength: 4096
code	string The unique product code for this product, normally defined by the underlying banking core. The code cannot be changed once the state is beyond pending. maxLength: 64
newAccountAvailability	newAccountAvailability Indicates if the product is available for opening new accounts. available means the product may be selected for a new account application. notAvailable means the product may not be selected for a new account application. The default is available. Note that clients must check both the product state and the newAccountAvailability when listing products for new account opening. The ?openable=true query parameter on /accounts combines these. Labels and descriptions for the enumeration values are in the newAccountAvailability key in the response of the getLabels operation.
category	string The product category name. This is a more readable form of the product's type.
rate	rate The interest rate for this product.
revision	string The revision string for this product. This property derived and immutable.
ifxType	ifxType The product IFX Account Type.
target	productTarget Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation.
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.
_id	string The unique identifier for this product resource. This is an immutable opaque string. read-only
type	string The product type name, which is derived from the linked product type. read-only
subtype	string The product subtype name, which is derived from the linked product subtype. This is a derived, immutable property. read-only
timeDeposit	timeDeposit Properties of time deposit products, primarily Certificate of Deposit products. This schema is version v1.0.0.
constraints	constraints Product constraints, such as minimum and maximum balances. This schema is version v1.0.0.

organization

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "customerId": "000489353781",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "tradeName": "Smith's Auto Detailing",
  "emailAddresses": [
    {
      "_id": "ea0",
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "preferredEmailAddressId": "ea0",
  "phones": [
    {
      "type": "work",
      "number": "(555) 555-5555",
      "_id": "wp0"
    },
    {
      "type": "mobile",
      "number": "(999) 555-5555",
      "_id": "wp1"
    }
  ],
  "preferredPhoneNumberId": "wp0",
  "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"
    }
  ],
  "preferredMailingAddressId": "wa0",
  "establishedDate": "2009-07-09T",
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "state": "active",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "currency": "USD",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "receivedAch": "upToOneHundredThousand",
    "sentAch": "moreThanOneMillion"
  },
  "type": "corporation",
  "subtype": "soleProprietorship",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "countryOfOperations": "US",
  "physicalLocationsCount": "under10",
  "mobileCheckDepositEnabled": true,
  "achEnabled": true,
  "authorizedSigners": [],
  "beneficialOwners": [],
  "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

Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization.

An organization which is used for a business banking account may have authorized signers, which are people authorized to perform banking operations on the business account(s) such as initiating funds transfers.

Regulations require identifying an organization's beneficial owners: people who own 25% or more of a business. These may be listed and updated with the getBeneficialOwners and updateBeneficialOwners operations.

An organization may have the following links in the _links object:

• apiture:activate - Activate a new, pending organization.
• apiture:deactivate - Deactivate an organization (if it is pending or active).
• apiture:remove - Remove an inactive organization.
• apiture:authorizedSigners - List the authorized signers.
• apiture:beneficialOwners - List the beneficial owners.

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.
_embedded	object Embedded objects, as selected with the ?embed query parameter.
» authorizedSigners	authorizedSigners The list of users who are authorized to access the organization and its bank accounts.
» beneficialOwners	beneficialOwners A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future.
_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	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
tradeName	string The trade name of the organization.
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.
employeeCountRange	string Indicates the approximate number of employees, as a range.
employeeCountLowerBound	integer The lower bound of persons employed, derived from the range selected in employeeCountRange. read-only minimum: 1
employeeCountUpperBound	number The lower bound of persons employed, derived from the range selected in employeeCountRange. read-only 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	regulatory 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
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	estimatedMonthlyAmounts Estimated monthly amounts for banking services.
accountPurpose	accountPurpose The purpose of the account.
registeredIn	string The US state or other region in which the organization is registered. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
_id	string The unique identifier for this organization resource. This is an immutable opaque string. read-only
customerId	string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API). read-only minLength: 1 maxLength: 100
createdAt	string(date-time) The date-time when the organization was created.
updatedAt	string(date-time) The date-time when the organization was updated
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.

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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "businessVerifications": [
    {
      "state": "passed",
      "completedAt": "2020-05-21T14:05:13Z",
      "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

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	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 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

approval

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
  "reason": "Invalid U.S. Address",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:approvalType": {
      "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
    },
    "apiture:target": {
      "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
    }
  },
  "_embedded": {
    "approvalType": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "governmentId",
      "label": "Government Issued ID",
      "description": "A document that identifies a user"
    }
  }
}

Approval

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. 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 bank customer may lack permissions to approve a wire transfer they submitted.

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.
_embedded	approvalEmbeddedObjects Embedded objects.
_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	approvalState The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type. read-only
done	boolean If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable. read-only
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. read-only
attributes	object An optional map of name/value pairs which provide additional metadata about the approval.
reason	string The reason given for the last state change, such as why the approval was approved, rejected, waived, canceled, or returned. maxLength: 512
createdAt	string(date-time) The date-time when the approval was created.
updatedAt	string(date-time) The date-time when the approval was updated.

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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "accountTitle": "John Smith",
  "title": "John Smith",
  "institutionName": "3rd Party Bank",
  "routingNumber": "021000021",
  "accountNumbers": {
    "masked": "*************3210",
    "full": "9876543210"
  },
  "ifxType": "CCA"
}

Transfer Account

Summary properties of the source and target account for a transfer.

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.
_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.
accountTitle	string The title of the account. Traditionally, this is the name of the account holder. This field is deprecated and will be removed in a future release; use title instead. maxLength: 512
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
ifxType	ifxType A code which identifies the product type. This is one of the IFX AcctType values. read-only

abstractRequest

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Request

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

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.
_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.

abstractResource

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

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.
_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.

collection

{
  "_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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

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.
_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.
count	integer The number of items in the collection. This value is optional and may 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.

contact

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "emailAddresses": [
    {
      "_id": "ea1",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "preferredPhoneId": "pa1",
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "residencyStatus": "resident",
  "occupation": "officeAndAdministrativeSupport",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "identityVerification": {
    "provider": "IDology",
    "sessionId": "123456",
    "scoredAt": "2019-09-13T13:06:52.078Z",
    "score": "passed",
    "state": "verified"
  },
  "yearsAtAddress": 3,
  "mailingDifferentAddress": false,
  "kycAnswers": {
    "citizen": true,
    "permanentResident": true,
    "w9Withholdings": false,
    "employmentStatus": "fullTime",
    "occupation": "officeAndAdministrativeSupport",
    "foreignPoliticalFigure": false,
    "countryPoliticalFigure": "N/A",
    "familyOfPoliticalFigure": false
  },
  "state": "active",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Contact

Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.

Properties

Name	Description
kycAnswers	object An object that contains the answers to Know Your Customer (KYC) questions. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.
identityVerificationStatus	string Use the state of identityVerification. The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts. read-only Enumerated values: verified unverified
identityVerification	identityVerification The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.
firstName	string The person's first name (or given name).
middleName	string The person's middle name.
lastName	string The person's last name (or surname).
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
emailAddresses	[typedEmailAddress] An array of email addresses.
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
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	[identification] A collection of official identifying information associated with the contact.
preferredContactMethod	preferredContactMethod The contact's preferred method of communication.
birthdate	string(date) The contact's birth date in YYYY-MM-DD format.
citizenship	citizenship This individual's citizenship or nationality status.
residencyStatus	residencyStatus This individual's residency status.
occupation	occupation The occupation of this individual.
otherOccupation	string The actual occupation of this individual if their occupation is other. This is ignored if occupation is not other. minLength: 4 maxLength: 32
yearsAtAddress	yearsAtAddress The number of years the person has been at their present home address.
_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 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.
state	contactState The state of this person's record. read-only
_id	string The unique identifier for this contact resource. This is an immutable opaque string. read-only
attributes	object An optional map of name/value pairs which provide additional metadata about the contact.
createdAt	string(date-time) The date-time when the contact was created.
updatedAt	string(date-time) The date-time when the contact was updated

summaryUser

{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "state": "approved",
      "_links": {
        "self": {
          "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
        }
      }
    }
  ],
  "preferredMailingAddressId": "stri",
  "emailAddresses": [
    {
      "_id": "pe1",
      "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
      "type": "personal",
      "number": "555-555-5555",
      "state": "approved",
      "_links": {
        "self": {
          "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
        },
        "delete": {
          "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
        },
        "apiture:setAsPreferred": {
          "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
        }
      }
    }
  ],
  "preferredEmailAddressId": "stri",
  "phones": [
    {
      "_id": "hp1",
      "type": "home",
      "number": "555-555-5555"
    }
  ],
  "preferredPhoneId": "stri",
  "prefix": "string",
  "suffix": "string",
  "preferredName": "string",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111",
      "expiration": {}
    }
  ],
  "preferredContactMethod": "unknown",
  "birthdate": "2020-05-21",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "residencyStatus": "unknown",
  "occupation": "unknown",
  "otherOccupation": "string",
  "yearsAtAddress": "unknown",
  "kycAnswers": {
    "citizen": true,
    "permanentResident": true,
    "w9Withholdings": true,
    "employmentStatus": "unknown",
    "foreignPoliticalFigure": false,
    "countryPoliticalFigure": "string",
    "familyOfPoliticalFigure": true,
    "foreignPoliticalFigureCountry": "st",
    "foreignPoliticalFigureAssociation": "unknown"
  },
  "identityVerification": {
    "provider": "string",
    "sessionId": "string",
    "scoredAt": "2019-09-13T06:11:01.375Z",
    "score": "passed",
    "state": "verified"
  },
  "username": "string",
  "state": "active",
  "phoneNumbers": [
    {
      "_id": "hp1",
      "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
      "type": "home",
      "number": "555-555-5555",
      "state": "approved",
      "_links": {
        "self": {
          "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
        }
      }
    }
  ],
  "_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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "_id": "string",
  "customerId": "00047294723672"
}

Summary User

Summary representation of a user resource in user 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
firstName	string The person's first name (or given name).
middleName	string The person's middle name.
lastName	string The person's last name (or surname).
addresses	[userAddress] An array of postal/mailing addresses. Add or delete addresses with the createAddress and deleteAddress operations. read-only
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
emailAddresses	[userEmailAddress] An array of email addresses. Add or delete email addresses with the createEmailAddress and deleteEmailAddress operations. read-only
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
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	[identification] A collection of official identifying information associated with the contact.
preferredContactMethod	preferredContactMethod The contact's preferred method of communication.
birthdate	string(date) The contact's birth date in YYYY-MM-DD format.
citizenship	citizenship This individual's citizenship or nationality status.
residencyStatus	residencyStatus This individual's residency status.
occupation	occupation The occupation of this individual.
otherOccupation	string The actual occupation of this individual if their occupation is other. This is ignored if occupation is not other. minLength: 4 maxLength: 32
yearsAtAddress	yearsAtAddress The number of years the person has been at their present home address.
kycAnswers	kycAnswers This user's answers Know Your Customer (KYC) questions. read-only
identityVerification	identityVerification The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only
username	string The unique username for the user.
state	string The state of this user record. The default is active. Users may not be deleted, but Users with a state of active, inactive or locked may be removed by POSTing to the /removedUsers endpoint via the apiture:remove endpoint. Removed users may not be reactivated. Users with a state of active or locked may be deactivated by POSTing to the /inactiveUsers endpoint via the apiture:deactivate endpoint. Users with a state of inactive or locked may be activated by POSTing to the /activeUsers endpoint via the apiture:activate endpoint. Users with a state of active or inactive may be locked by POSTing to the /lockedUsers endpoint via the apiture:lock endpoint. A state of locked indicates a user has entered the password incorrectly too many times. Users with a state of active, inactive or locked may be frozen by POSTing to the /frozenUsers endpoint via the apiture:freeze endpoint. A state of frozen indicates a user can no longer access online banking until the financial institution re-activates the user. Users with a state of active, inactive, or locked may be merged by POSTing to the /mergedUsers endpoint via the apiture:merge endpoint. Merged users may not have their state changed. Enumerated values: active inactive locked frozen merged removed
phoneNumbers	[userPhoneNumber] An array of phone numbers. Add or delete phoneNumbers with the createPhoneNumber and deletePhoneNumber operations. read-only
_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 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 user resource. This is an opaque string. read-only
customerId	string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API). read-only minLength: 1 maxLength: 100

role

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "name": "primaryUser",
  "label": "Primary User",
  "createdAt": "2018-02-01T13:07:01.375Z",
  "description": "The account owner has full control across the account.\n\nThere may be only one primary user."
}

Role

Representation of a role resource. Roles are used to associate resources. The most common roles may be related to entitlements(users) but can also be applied to organizations or non-users (such as beneficiaries, payees, etc.).

Properties

Name	Description
name	string The name of this role, for identification purposes, such as primaryOwner, 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
_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 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. read-only
createdAt	string(date-time) The date-time when the role was created. This is in ISO 8601 format, UTC. This is derived and immutable. read-only

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",
      "createdAt": "2018-01-12T10:15:17Z"
    },
    {
      "type": "quiz",
      "_links": {
        "self": {
          "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
        }
      },
      "state": "passed",
      "createdAt": "2018-01-12T10:19:41Z"
    }
  ]
}

Verification

The contact's verification history and status.

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.
_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	[identityHistoryItem] The history of this contact's identity verifications.

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": "productTermsAndConditions",
  "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

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(uri) 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. maxLength: 2048
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	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 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. read-only
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

fraudRiskReport

{
  "_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v2.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/v2.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": {
    "state": "passedWithRiskFactors",
    "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 watchlists"
      },
      {
        "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

The result of running a fraud-risk analysys.

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.
_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.
provider	string The name of the identity verification provider.
sessionId	string The unique id for a session of the identity verification process.
scoredAt	string(date-time) The date-time when the provider ran identity verification. This is an RFC 3339 time stamp.
score	string The indication if the contact has passed or failed the identity verification process. Enumerated values: passed failed expired
state	string The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only Enumerated values: verified unverified
inputs	fraudRiskReportInputs The inputs of a fraud-risk report.
outputs	fraudRiskReportOutputs The outputs of a fraud-risk report.

verificationReport

{
  "createdAt": "2018-04-17T10:04:46.375Z",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "input": {
    "businessName": "ABC EXAMPLE CO.",
    "phone": "555-555-1234",
    "identification": [
      {
        "type": "taxId",
        "value": "12-347894309"
      }
    ],
    "authorizedSigners": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "identification": [
          {
            "type": "taxId",
            "value": "121-34-5431"
          }
        ],
        "birthdate": "1980-12-01",
        "email": "email@email.com"
      }
    ],
    "addresses": [
      {
        "addressLine1": "3212 N. 2nd Ave.",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28412"
      }
    ]
  },
  "reportScoringSummary": {
    "transactionId": "578490325jk439834yuf43",
    "state": "failed",
    "businessVerification": [
      {
        "value": 40,
        "description": "Strong verification of the input data is confirmed"
      }
    ],
    "businessRiskFactors": [
      {
        "riskCode": "20",
        "description": "Unable to verify business address on business records"
      },
      {
        "riskCode": "21",
        "description": "Unable to verify business TIN on business records"
      }
    ],
    "comprehensiveVerificationScores": [
      {
        "inputRepNumber": "1",
        "score": 20,
        "description": "Full name, address, phone, SSN verified"
      }
    ],
    "authorizedRepresentativeRiskFactors": [
      {
        "riskCode": "81",
        "description": "The input date-of-birth was missing or incomplete"
      },
      {
        "riskCode": "25",
        "description": "Unable to verify address"
      }
    ]
  },
  "reportResults": {}
}

Verification Report

Representation of verification report resources.

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.
_embedded	object The objects which participate in this verification report
_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 verification report resource. This is an immutable opaque string. read-only
reportScoringSummary	verificationReportScoringSummary Model schema for business verification report summary.
createdAt	string(date-time) An ISO 8601 UTC time stamp indicating when the verification report was created.
input	createVerificationReport Representation used to create a new verification report.
reportResults	object The raw verification report results

externalAccountState

"active"

External Account State

The state of an external (linked) banking account. This field is immutable and derived.

• pending : A new external account that has not been verified
• verifying : A new account that is being verified. This state only applies to external accounts.
• failed : A external account which has failed account verification.
• active : An account which is active and available for use and for making new transactions.
• inactive : An account which is marked inactive and not available for new transactions. Inactive accounts may be changed back to active.
• frozen : An account which is frozen and not eligible for new transactions. This is typically the result of suspicious activity or fraud detection. The user must contact their financial institution to unfreeze the account (by changing the state back to active) or the financial institution may opt to close the account.
• closed : An account that is closed and removed from use. Closed accounts are not eligible for transactions or to become active. Such accounts are retained for historical purposes because some transactions may refer to it. Users do not see closed accounts when they view their accounts.
• underReview : A new account that is being under review. This state only applies to external accounts.

To change the state of an account, POST the account ID to the corresponding resource endpoints, using the corresponding link on the account resource. To activate an account, use the apiture:activate link to POST to /accounts/activeAccounts. To deactivate an account, use the apiture:deactivate link to POST to /accounts/inactiveAccounts. To freeze an account, use the apiture:freeze link to POST to /accounts/frozenAccounts. To close an account, use the apiture:close link to POST to /accounts/closedAccounts. To under review an account, use the apiture:review link to POST to /accounts/externalAccountsUnderReview.

Type: string
Enumerated values:
pending
verifying
failed
active
inactive
frozen
closed
underReview

attributeValue

{}

Attribute Value

The data associated with this attribute.

Properties

links

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

Links

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.

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error

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. read-only
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.

configurationValue

{}

Configuration Value

The data associated with this configuration.

Properties

identityHistoryItem

{
  "state": "passed",
  "createdAt": "2019-11-21T08:43:54.375Z",
  "type": "quiz",
  "_links": {
    "apiture:contact": {
      "href": "/contacts/contacts/d77bef0b-c75c-4192-ba88-278b9ce4063b"
    }
  }
}

Identity Verification Item

One verification record for a contact's history of verifications. This may contain a link to the contact in the link apiture:contact.

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.
state	identityVerificationState (required) The type of the historical verification.
type	identityVerificationType Describes how the identity verification was performed.
createdAt	string(date-time) (required) The date-time when the verification occurred or completed. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.
expiredAt	string(date-time) The date-time when the verification expired. This is only set if the state is expired. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.

configurationSchemaValue

{}

Configuration Schema Value

The data associated with this configuration schema.

Properties

summaryContact

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "emailAddresses": [
    {
      "_id": "ea1",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "preferredPhoneId": "pa1",
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "residencyStatus": "resident",
  "occupation": "officeAndAdministrativeSupport",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "identityVerification": {
    "provider": "IDology",
    "sessionId": "123456",
    "scoredAt": "2019-09-13T13:06:52.078Z",
    "score": "passed",
    "state": "verified"
  },
  "yearsAtAddress": 3,
  "mailingDifferentAddress": false,
  "kycAnswers": {
    "citizen": true,
    "permanentResident": true,
    "w9Withholdings": false,
    "employmentStatus": "fullTime",
    "occupation": "officeAndAdministrativeSupport",
    "foreignPoliticalFigure": false,
    "countryPoliticalFigure": "N/A",
    "familyOfPoliticalFigure": false
  },
  "state": "active",
  "_links": {
    "self": {
      "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Contact Summary

Summary representation of a contact resource in contacts 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
kycAnswers	object An object that contains the answers to Know Your Customer (KYC) questions. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.
identityVerificationStatus	string Use the state of identityVerification. The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts. read-only Enumerated values: verified unverified
identityVerification	identityVerification The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.
firstName	string The person's first name (or given name).
middleName	string The person's middle name.
lastName	string The person's last name (or surname).
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
emailAddresses	[typedEmailAddress] An array of email addresses.
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
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	[identification] A collection of official identifying information associated with the contact.
preferredContactMethod	preferredContactMethod The contact's preferred method of communication.
birthdate	string(date) The contact's birth date in YYYY-MM-DD format.
citizenship	citizenship This individual's citizenship or nationality status.
residencyStatus	residencyStatus This individual's residency status.
occupation	occupation The occupation of this individual.
otherOccupation	string The actual occupation of this individual if their occupation is other. This is ignored if occupation is not other. minLength: 4 maxLength: 32
yearsAtAddress	yearsAtAddress The number of years the person has been at their present home address.
_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 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.
state	contactState The state of this person's record. read-only
_id	string The unique identifier for this contact resource. This is an immutable opaque string. read-only

summaryVerificationReport

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Verification Report Summary

Summary representation of a verification report resource in verification report 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	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 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 verification report resource. This is an immutable opaque string. read-only
reportScoringSummary	verificationReportScoringSummary Model schema for business verification report summary.

createVerificationReport

{
  "_profile": "https://production.api.apiture.com/schemas/businessVerifications/createVerificationReport/v2.0.0/profile.json",
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": [
    {
      "type": "taxId",
      "value": "12-347894309"
    }
  ],
  "attributes": {},
  "addresses": [
    {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  ],
  "authorizedSigners": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": [
        {
          "type": "taxId",
          "value": "121-34-5431"
        }
      ],
      "birthdate": "1980-12-01",
      "email": "email@email.com"
    }
  ]
}

Create Verification Report

Representation used to create a new verification report.

Properties

Name	Description
businessName	string The business's name minLength: 1 maxLength: 512
alternateBusinessName	string An alternate name for the business minLength: 1 maxLength: 512
phone	string The business's phone minLength: 1 maxLength: 32
identification	identificationModel A collection of official identifying information associated with an entity.
authorizedSigners	[authorizedSigner] An optional array of authorized signer entities
addresses	[address] An array of postal mailing addresses for this contact.
attributes	attributes An optional map of name/value pairs which provide additional metadata about the verification report.
_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 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.

verificationReportScoringSummary

{
  "transactionId": "string",
  "state": "passed",
  "businessVerifications": [
    {
      "value": "string",
      "description": "string"
    }
  ],
  "businessRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ],
  "comprehensiveVerificationScores": [
    {
      "inputRepNumber": "string",
      "score": 0,
      "description": "string"
    }
  ],
  "authorizedRepresentativeRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ]
}

Verification Report Summary

Model schema for business verification report summary.

Properties

Name	Description
transactionId	string The unique transactionId for this verification report used for tracking this verification report
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. Enumerated values: passed failed
businessVerifications	[businessVerificationScore] A list of business verification scores.
businessRiskFactors	[riskFactor] A list of business verification risk factors.
comprehensiveVerificationScores	[comprehensiveVerificationScore] A list of comprehensive business verification scores.
authorizedRepresentativeRiskFactors	[riskFactor] A list of representative business risk factors.

configurationGroupSummary

{
  "_profile": "https://api.apiture.com/schemas/configurations/configurationGroupSummary/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary

A summary of the data contained within a configuration group resource.

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.
_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

businessVerification

{
  "state": "passed",
  "completedAt": "2020-05-21T14:05:13Z",
  "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

The verification report contains analsys 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. Enumerated values: passed failed
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. Enumerated values: verificationReport administratorApproval
_id	string This business verification's unique id read-only
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

updateRole

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
  "label": "primary user",
  "name": "primaryUser",
  "description": "The primary user for this account."
}

Update Role

Representation used to update or patch a role.

Properties

Name	Description
name	string The name of this role, for identification purposes, such as primaryOwner, 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
_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 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. read-only

updateApproval

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json"
}

Update Approval

Representation used to update or patch an approval. The state field is immutable and not updated by this operation, but by the state transition POST operations such as approve or reject (ex. apiture:approve and apiture:reject).

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.
_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	approvalState The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type. read-only
done	boolean If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable. read-only
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. read-only
attributes	object An optional map of name/value pairs which provide additional metadata about the approval.

approvalEmbeddedObjects

{
  "approvalType": {
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
    "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
    "_links": {
      "self": {
        "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "target": {}
}

Approval Embedded Objects

The objects which participate in this approval.

Properties

Name	Description
approvalType	summaryApprovalType The type of this approval.
target	object The target of this approval.

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

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	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 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	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
tradeName	string The trade name of the organization.
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.
employeeCountRange	string Indicates the approximate number of employees, as a range.
employeeCountLowerBound	integer The lower bound of persons employed, derived from the range selected in employeeCountRange. read-only minimum: 1
employeeCountUpperBound	number The lower bound of persons employed, derived from the range selected in employeeCountRange. read-only 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	regulatory 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
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	estimatedMonthlyAmounts Estimated monthly amounts for banking services.
accountPurpose	accountPurpose The purpose of the account.
registeredIn	string The US state or other region in which the organization is registered. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
_id	string The unique identifier for this organization resource. This is an immutable opaque string. read-only
customerId	string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API). read-only minLength: 1 maxLength: 100

authorizedSigners

{
  "_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": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "items": [
    {
      "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
      "customerId": "00047294723672",
      "type": "joint",
      "role": "Chief Financial Officer",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "taxId": "111-11-1111",
      "citizen": true,
      "addresses": [
        {
          "_id": "ha5",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "id": "wa0",
          "type": "other",
          "label": "mailing",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "preferredMailingAddressId": "ha5",
      "emailAddress": "JohnDanielSmith@example.com"
    }
  ]
}

Authorized Signers

The list of users who are authorized to access the organization and its bank accounts.

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.
_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.
items	[authorization] The array of authorized signers for this business and their role within the organization. These people have account access for all business accounts owned by the business. The items in this array must all have the type of authorizedSigner. minLength: 1

beneficialOwners

{
  "items": [
    {
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": [
        {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      ],
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": {},
      "identification": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ]
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}

Beneficial Owners

A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future.

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.
_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.
items	[beneficialOwner] (required) A list of people who own at least 25% of the business, and the percentage owned. maxLength: 10

accountNumbers

{
  "masked": "*************3210",
  "full": "9876543210"
}

Account Numbers

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

ifxType

"CCA"

IFX Account Type (v1.0.0)

A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.

ifxType strings may have one of the following enumerated values values (described by the named ifxType)

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

Value	Description
CCA	Credit card account
CDA	Certificate of deposit account (CD)
CLA	Commercial loan account
CMA	Cash management account
DDA	Demand deposit account
EQU	Home equity loan
GLA	General ledger account
ILA	Installment loan account
INV	Investment account
IRA	Individual retirement account
IRL	Accounts held in Ireland
LOC	Consumer line of credit
MLA	Military Lending Account: Credit facility held by former US service member
MMA	Money market account
PBA	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
PPA	Private pension administrator
RWD	Reward accounts
SDA	Savings deposit account

This schema is version v1.0.0.

Type: string
Enumerated values:
CCA
CDA
CLA
CMA
DDA
EQU
GLA
ILA
INV
IRA
IRL
LOC
MLA
MMA
PBA
PPA
RWD
SDA

link

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

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.

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.

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": "productTermsAndConditions",
  "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

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(uri) 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. maxLength: 2048
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	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 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. read-only
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

revisionEffectiveInterval

{
  "effectiveStartAt": "2020-05-21T14:05:13Z",
  "effectiveEndAt": "2020-05-21T14:05:13Z"
}

Revision Effective Time Interval

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.

timeDeposit

{
  "maturityPolicy": "rolloverPrincipalAndInterest",
  "minimumTerm": "P31D",
  "maximumTerm": "P31D",
  "fees": "string"
}

Time Deposit Products (v1.0.0)

Properties of time deposit products, primarily Certificate of Deposit products.

This schema is version v1.0.0.

Properties

Name	Description
maturityPolicy	maturityPolicy Indicates how the principal and interest are processed upon maturity. The values indicate whether to rollover (to a time deposit account of the same rate and term), transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation. maturityPolicy strings may have one of the following enumerated values values (described by the named maturityPolicy) These enumeration values are further described by the label group named maturityPolicy in the response from the getLabels operation. Value Description rolloverPrincipalAndInterest Rollover principal and interest to a new CD of the same product: Upon maturity, both principal and interest rollover into a specified banking product, such as a savings, checking, or other deposit account. transferPrincipalAndInterest Transfer principal and interest to a deposit account: Upon maturity, the principal an interest are both transferred to an existing or new deposit account. rolloverPrincipalAndTransferInterest Transfer interest to a new deposit account an rollover principal to a new CD of the same product: Upon maturity, the principal rolls over into a specified banking product and the interest is transferred to an existing deposit account. holdPrincipalAndInterest Hold principal and accued interest in the CD account until withdrawal: Upon maturity, the principal and interest are held in the current time deposit account. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred. partialTransfer Partial Transfer: Upon maturity, any funds greater than the maturity threshold is transfered to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred. This schema is version v1.0.0.
minimumTerm	string(period) The minimum maturity term offered by this product, for products such as certificates of deposits. See also maximumTerm For example, Some CD products may be opened with a flexible term such as 31 to 181 days, expressed as minimumTerm: P31D, maximumTerm: P181D For fixed-term products, minimmumTerm and maximumTerm should be the same. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively.
maximumTerm	string(period) The maximum maturity term offered by this product, for products such as certificates of deposits. If omitted, there is no fixed term (not all product types impose a term). For example, Some CD products may be opened with a flexible term such as 31 to 181 days, expressed as minimumTerm: P31D, maximumTerm: P181D For fixed-term products, minimmumTerm and maximumTerm should be the same. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively.
fees	string(period) The time period in which additional deposits may be made to a CD after it has rolled over after maturity. This value applies only if the depositsAllowed is duringGracePeriod. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days.

constraints

{
  "transactionTypes": {
    "0": "debit",
    "1": "credit"
  },
  "minimumBalance": "500.00",
  "minimumFundingAmount": "500.00",
  "maximumFundingAmount": "2500.00",
  "minimumTransferAmount": "25.00",
  "maximumTransferAmount": "10000.00",
  "maximumWithdrawalCount": 6,
  "fundingTerm": "P30D",
  "depositsRestrictedAfterGracePeriod": true,
  "depositsRestrictedAfterFunding": true,
  "gracePeriod": "P14D"
}

Product Constraints (v1.0.0)

Product constraints, such as minimum and maximum balances.

This schema is version v1.0.0.

Properties

Name	Description
transactionTypes	transactionTypes The types of transactions permitted for this account. Values which appear in this array are permitted. Default: ["debit","credit"]
minimumBalance	string The minimum balance for accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumFundingAmount	string The minimum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumFundingAmount	string The maximum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumTransferAmount	string The minimum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumTransferAmount	string The maximum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumWithdrawalCount	integer The maximum number of withdrawals allowed per cycle. If not present, there is no hard limit.
fundingTerm	string(period) The time limit within which account opening funding must occur after account creation. This is expressed as an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.
depositsRestrictedAfterGracePeriod	boolean If true, deposits are not allowed after the rollover grace period (see gracePeriod). This applies to time deposit products only. Default: true
depositsRestrictedAfterFunding	boolean If true, deposits are not allowed after the initial account funding has completed. This typically applies to time deposit products. Default: true
gracePeriod	string(period) A period of time after account rollover when additional deposits are allowed. This is an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.

summaryRole

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
  "name": "primaryUser",
  "label": "Primary User",
  "description": "The primary user on the account.\nThere may be only one primary user on an account.",
  "_links": {
    "self": {
      "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Role Summary

Summary representation of a role resource in roles 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
name	string The name of this role, for identification purposes, such as primaryOwner, 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
_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 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. read-only

verificationRequestFields

{
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": [
    {
      "type": "taxId",
      "value": "12-347894309"
    }
  ],
  "attributes": {},
  "addresses": [
    {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  ],
  "authorizedSigners": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": [
        {
          "type": "taxId",
          "value": "121-34-5431"
        }
      ],
      "birthdate": "1980-12-01",
      "email": "email@email.com"
    }
  ]
}

Verification Request Fields

Common fields of a verification request, used to build other model schemas.

Properties

Name	Description
businessName	string The business's name minLength: 1 maxLength: 512
alternateBusinessName	string An alternate name for the business minLength: 1 maxLength: 512
phone	string The business's phone minLength: 1 maxLength: 32
identification	identificationModel A collection of official identifying information associated with an entity.
authorizedSigners	[authorizedSigner] An optional array of authorized signer entities
addresses	[address] An array of postal mailing addresses for this contact.
attributes	attributes An optional map of name/value pairs which provide additional metadata about the verification report.

identityVerificationState

"passed"

IdentityVerification Type

The type of the historical verification.

Type: string
Enumerated values:
passed
failed
passedWithRiskFactors
pending
asked
identityServiceFailure
scoring
expired

identityVerificationType

"fraudRiskReport"

Identity Verification Type

Describes how the identity verification was performed.

Type: string
Enumerated values:
fraudRiskReport
quiz
adminApproval

authorization

{
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "00047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "taxId": "111-11-1111",
  "citizen": true,
  "addresses": [
    {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "id": "wa0",
      "type": "other",
      "label": "mailing",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha5",
  "emailAddress": "JohnDanielSmith@example.com"
}

Authorization

Represents a person authorized for account access. This object contains key identification information for the person and the type of access or role that the person has in relation to the banking account or organization.

Properties

Name	Description
firstName	string (required) The person's first name (or given name).
middleName	string The person's middle name.
lastName	string (required) The person's last name (or surname).
addresses	[address] (required) An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
taxId	string (required) Official government identification (tax ID) for this person.
citizen	boolean (required) Indicates if the person is a (US) citizen.
emailAddress	string(email) Optional email address.
userId	string (required) The unique ID of the user. This is the _id value of the user resource from the Users API.
customerId	string (required) The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API). read-only minLength: 1 maxLength: 100
type	authorizationType (required) The type of this account access authorization. primary the contact is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account. joint the contact is a non-primary joint owner of a personal account. The target of the authorization is a single personal account. authorizedSigner the contact is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
role	string The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.

beneficialOwner

{
  "firstName": "William",
  "lastName": "Wellphunded",
  "addresses": [
    {
      "addressLine1": "1234 S Front Street",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "type": "home"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "role": "Chief Financial Officer",
  "birthdate": {},
  "percentage": 35,
  "contactId": "8bf04d7d-c1bd-4945-b0ac-40ef02bb3953"
}

Beneficial Owner

A person who owns 25% or more of a business organization.

Properties

Name	Description
firstName	string (required) The person's first name (or given name).
middleName	string The person's middle name.
lastName	string (required) The person's last name (or surname).
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
emailAddresses	[typedEmailAddress] An array of email addresses.
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
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	[identification] (required) A collection of official identifying information associated with the contact.
preferredContactMethod	preferredContactMethod The contact's preferred method of communication.
role	string The person's role at the organization.
percentage	integer (required) The percent of the business that this person owns. maximum: 100
birthdate	string(date) The beneficial's birth date in YYYY-MM-DD format.
contactId	string (required) The _id of an existing contact resource associated with the beneficial owner. Create the beneficial owner contact resource using the Contacts API.

contactVerificationFields

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "emailAddresses": [
    {
      "_id": "ea1",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "preferredPhoneId": "pa1",
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "residencyStatus": "resident",
  "occupation": "officeAndAdministrativeSupport",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "identityVerification": {
    "provider": "IDology",
    "sessionId": "123456",
    "scoredAt": "2019-09-13T13:06:52.078Z",
    "score": "passed",
    "state": "verified"
  },
  "yearsAtAddress": 3,
  "mailingDifferentAddress": false,
  "kycAnswers": {
    "citizen": true,
    "permanentResident": true,
    "w9Withholdings": false,
    "employmentStatus": "fullTime",
    "occupation": "officeAndAdministrativeSupport",
    "foreignPoliticalFigure": false,
    "countryPoliticalFigure": "N/A",
    "familyOfPoliticalFigure": false
  },
  "state": "active"
}

Contact Fields

Common fields of the contact resource used to build other model schemas for people who hold bank accounts.

Properties

Name	Description
kycAnswers	object An object that contains the answers to Know Your Customer (KYC) questions. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.
identityVerificationStatus	string Use the state of identityVerification. The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts. read-only Enumerated values: verified unverified
identityVerification	identityVerification The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. Warning: This property is deprecated. Identity verification details will only exist on Users, not Contacts.

contactState

"inactive"

Contact State

The state of this person. The values are described in the contactState text via the getLabels operation.

Type: string
Enumerated values:
inactive
active
merged
removed

summaryApproval

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Approval Summary

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	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 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	approvalState The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type. read-only
done	boolean If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable. read-only
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. read-only

maturityPolicy

"rolloverPrincipalAndInterest"

Maturity Policy (v1.0.0)

Indicates how the principal and interest are processed upon maturity. The values indicate whether to rollover (to a time deposit account of the same rate and term), transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation.

maturityPolicy strings may have one of the following enumerated values values (described by the named maturityPolicy)

These enumeration values are further described by the label group named maturityPolicy in the response from the getLabels operation.

Value	Description
rolloverPrincipalAndInterest	Rollover principal and interest to a new CD of the same product: Upon maturity, both principal and interest rollover into a specified banking product, such as a savings, checking, or other deposit account.
transferPrincipalAndInterest	Transfer principal and interest to a deposit account: Upon maturity, the principal an interest are both transferred to an existing or new deposit account.
rolloverPrincipalAndTransferInterest	Transfer interest to a new deposit account an rollover principal to a new CD of the same product: Upon maturity, the principal rolls over into a specified banking product and the interest is transferred to an existing deposit account.
holdPrincipalAndInterest	Hold principal and accued interest in the CD account until withdrawal: Upon maturity, the principal and interest are held in the current time deposit account. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.
partialTransfer	Partial Transfer: Upon maturity, any funds greater than the maturity threshold is transfered to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.

This schema is version v1.0.0.

Type: string
Enumerated values:
rolloverPrincipalAndInterest
transferPrincipalAndInterest
rolloverPrincipalAndTransferInterest
holdPrincipalAndInterest
partialTransfer

identityVerification

{
  "provider": "string",
  "sessionId": "string",
  "scoredAt": "2019-09-13T06:11:01.375Z",
  "score": "passed",
  "state": "verified"
}

Identity Verification Data

Data points on the identity verification process that tells if a user has passed, failed or expired the identity check.

Properties

Name	Description
provider	string The name of the identity verification provider.
sessionId	string The unique id for a session of the identity verification process.
scoredAt	string(date-time) The date-time when the provider ran identity verification. This is an RFC 3339 time stamp.
score	string The indication if the contact has passed or failed the identity verification process. Enumerated values: passed failed expired
state	string The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only Enumerated values: verified unverified

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

The inputs of a fraud-risk report.

Properties

Name	Description
identity	identity Information that describes the identity.

fraudRiskReportOutputs

{
  "token": "string",
  "providerReportId": "string",
  "state": "passed",
  "fraudRiskCategories": [
    {
      "type": "personalInfoDoesNotMatch",
      "description": "The retrieved identity does not match the provided PII.",
      "message": "ZIP code located does not match the ZIP code submitted."
    }
  ]
}

Fraud-risk Report Outputs

The outputs of a fraud-risk report.

Properties

Name	Description
token	string An opaque string that conveys the state of the contact's identity verification.
providerReportId	string External identity provider report Id.
state	fraudRiskReportState The state of a fraud report. passed indicates that the provided personally identifiable information (PII) was located and contains no risk factors. passedWithRiskFactors means that the provided PII matches an identity but contains risk factors. failed means that the provided PII does not match any identity records.
fraudRiskCategories	[fraudRiskCategory] A list of categories in this report.

summaryApprovalType

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Approval Type Summary

Summary representation of an approval type 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	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 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 approval's name.
label	string The approval's common name.
description	string The approval's description.
domain	string A namespace for grouping related resources, to keep them separate from other resources. For example, a department or bank branch may define a domain, and all Approval Type instances they define will use that domain, so that they can avoid conflicting with Approval Type names in other domains. An API or service may define a domain for new Approval Types that it defines. The combination of domain and name must be unique within the set of all approval types. It is a best practice to define domain with a URI or a URN.
disallowedStates	[disallowedState] An optional array of states that are not allowed for this approval type. If omitted, all state transitions are allowed. The states open and approved are always allowed, so this enumeration set is a subset of the approvalState enumeration on an approval.
_id	string The unique identifier for this approval resource. This is an immutable opaque string. read-only

userVerificationFields

{
  "kycAnswers": {
    "citizen": true,
    "permanentResident": true,
    "w9Withholdings": true,
    "employmentStatus": "unknown",
    "foreignPoliticalFigure": false,
    "countryPoliticalFigure": "string",
    "familyOfPoliticalFigure": true,
    "foreignPoliticalFigureCountry": "st",
    "foreignPoliticalFigureAssociation": "unknown"
  },
  "identityVerification": {
    "provider": "string",
    "sessionId": "string",
    "scoredAt": "2019-09-13T06:11:01.375Z",
    "score": "passed",
    "state": "verified"
  }
}

User Verification Fields

Fields for recording the status of user verification for a financial institution's Customer Identification Program (CIP). (This fragment schema is used to build other schemas.)

Properties

Name	Description
kycAnswers	kycAnswers This user's answers Know Your Customer (KYC) questions. read-only
identityVerification	identityVerification The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only

userAddress

{
  "_id": "ha1",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
    }
  }
}

User Address

Representation of a user's address resource.

Properties

Name	Description
type	addressType The type of this address.
label	string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
_id	string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.

userPhoneNumber

{
  "_id": "hp1",
  "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json",
  "type": "home",
  "number": "555-555-5555",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  }
}

Phone Number

Representation of phone number resources.

Properties

Name	Description
type	phoneNumberType The type or role of this phone number.
number	string The phone number, as a string. minLength: 8 maxLength: 16
label	string A text label, suitable for presentation to the end user. This is also used if type is other. maxLength: 32
_id	string An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.

userEmailAddress

{
  "_id": "pe1",
  "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json",
  "type": "personal",
  "number": "555-555-5555",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "delete": {
      "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
    }
  }
}

Email Address

Representation of email address resources. An email address is immutable, although users can add new email addresses.

Properties

Name	Description
value	string(email) The email address, such as JohnBankCustomer@example.com minLength: 8 maxLength: 120
type	emailType The kind of email address.
_id	string An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.

roleFields

{
  "name": "primaryUser",
  "label": "Primary User",
  "description": "The primary user on the account.\nThere may be only one primary user on an account."
}

Role Fields

Core fields of the role resource used to build other model schema.

Properties

Name	Description
name	string The name of this role, for identification purposes, such as primaryOwner, 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

businessVerificationScore

{
  "value": "string",
  "description": "string"
}

Business Verification Score

An score that summarizes the verification of the input information. This objects contains a score value and accompanying description.

Properties

Name	Description
value	string The business verification score value
description	string The business verification score description

riskFactor

{
  "riskCode": "string",
  "description": "string"
}

Risk Factor

Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.

Properties

Name	Description
riskCode	string The risk factor risk code
description	string The risk code description

comprehensiveVerificationScore

{
  "inputRepNumber": "string",
  "score": 0,
  "description": "string"
}

Authorized Representative Comprehensive Verification Score

The comprehensive verification score is a risk verification score for the authorized representative.

Properties

Name	Description
inputRepNumber	string the rep number for the authorized representative
score	integer The comprehensive verification score is a risk verification score of the authorized representative
description	string The description for the CVI value

authorizationType

"primary"

Account Authorization type

The type of this account access authorization.

• primary the person is the primary owner of a personal account. There may be only one primary owner.
• joint the person is a non-primary joint owner of a personal account.
• authorizedSigner the person is an authorized signer for all business accounts owned by the organization.

Type: string
Enumerated values:
primary
joint
authorizedSigner

identificationModel

{}

Identification Model

A collection of official identifying information associated with an entity.

identificationModel is an array schema.

Array Elements

Name	Description
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. For a person, taxId is their federal tax ID (such as social security number). For a business, taxId is the Federal Employer Identification Number or FEIN (also known as Tax Identification Number or TIN), and dunsNumber is the business' Dun & Bradstreet Number. Enumerated values: taxId dunsNumber

authorizedSigner

{
  "firstName": "Jane",
  "lastName": "Doe",
  "identification": [
    {
      "type": "taxId",
      "value": "121-34-5431"
    }
  ],
  "birthdat>": "1980-12-01",
  "email": "email@email.com"
}

Authorized Signer

Authorized Signers are primary bank users and co-owners of a business, optionally passed when creating verification reports.

Properties

Name	Description
firstName	string (required) The authorized signer's first name minLength: 1 maxLength: 512
lastName	string (required) The authorized signer's last name minLength: 1 maxLength: 512
identification	identificationModel A collection of official identifying information associated with an entity.
birthdate	string(date) The authorized signer'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 The authorized signer's email address minLength: 1 maxLength: 512

address

{
  "_id": "ha5",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Address

A postal address.

Properties

Name	Description
type	addressType (required) The type of this address.
label	string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
_id	string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$

simpleOrganization

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "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"
    }
  ],
  "establishedDate": "2009-07-09T"
}

Simple Organization

The simplest form of an organization.

Properties

Name	Description
name	string The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.

organizationState

"pending"

Organization State

The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.

Type: string
Enumerated values:
pending
inactive
active
merged
removed

regulatory

{
  "estimatedAnnualRevenue": "unknown",
  "atmOperator": true,
  "charity": true,
  "cashesChecksMoreThan1000Usd": true,
  "internetGamblingIncorporated": true,
  "marijuanaBusiness": true,
  "moneyOrderMoreThan1000Usd": true,
  "thirdPartyBenefit": true,
  "transmitBehalfOfCustomer": true,
  "virtualCurrency": true,
  "intermediaryServices": [
    "unknown"
  ],
  "subjectToWithholdings": false,
  "property1": {},
  "property2": {}
}

Regulatory

Responses to regulatory-related questions.

Properties

Name	Description
additionalProperties	regulatoryValue The value associated with this regulatory property.
estimatedAnnualRevenue	estimatedAnnualRevenue The range of estimated revenue in US dollars.
atmOperator	boolean The organization operates automated teller machines (ATMs).
charity	boolean Some of the organization's income depends on a charity.
cashesChecksMoreThan1000Usd	boolean The organization cashes checks for customers in amounts greater than $1,000.
internetGamblingIncorporated	boolean The organization derives income from internet gambling.
marijuanaBusiness	boolean The organization derives income from marijuana or other drugs/controlled substances.
moneyOrderMoreThan1000Usd	boolean Individuals at the organization may request money orders of more than $1,000.
thirdPartyBenefit	boolean The organization processes transactions on behalf of third parties.
transmitBehalfOfCustomer	boolean The organization transmits funds on behalf of third parties.
virtualCurrency	boolean The organization administers or exchanges virtual currency.
intermediaryServices	[intermediaryServices] A list of intermediary/non-bank financial institution services provided the organization performs on behalf of others. uniqueItems: true
subjectToWithholdings	boolean If true, the organization is subject to tax withholdings. Default: false

estimatedMonthlyAmounts

{
  "percentGrossRevenue": "string",
  "sentAch": "upToOneHundredThousand",
  "receivedAch": "oneHundredThousandToOneMillion",
  "mobileCheckDeposit": "oneHundredThousandToOneMillion",
  "sentWire": "oneHundredThousandToOneMillion",
  "receivedWire": "moreThanOneMillion"
}

Estimated Monthly Amounts

Estimated monthly amounts for banking services.

Properties

Name	Description
percentGrossRevenue	string The percentage of gross revenue the organization derives from money services.
sentAch	string Indicates the estimated monthly total amount to send by ACH.
receivedAch	string Indicates the estimated monthly total amount to receive by ACH.
mobileCheckDeposit	string Indicates the estimated monthly minimum amount to deposit.
sentWire	string Indicates the estimated monthly minimum wires amount sent.
receivedWire	string Indicates the estimated monthly minimum wires amount received.

accountPurpose

"unknown"

Account purpose

The purpose of the account.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the accountPurpose group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
creditCardProcessing
generalOperatingFunds
lottery
payroll
savings
other
notApplicable

simpleContact

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "emailAddresses": [
    {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "pe0",
  "phones": [
    {
      "_id": "hp1",
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "_id": "mp1",
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "preferredPhoneId": "hp1",
  "preferredContactMethod": "email"
}

Simple Contact

Basic contact and identification information for a person, consisting of the name, mailing address, phone numbers, email addresses, and government identification.

Properties

Name	Description
firstName	string The person's first name (or given name).
middleName	string The person's middle name.
lastName	string The person's last name (or surname).
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
emailAddresses	[typedEmailAddress] An array of email addresses.
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
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	[identification] A collection of official identifying information associated with the contact.
preferredContactMethod	preferredContactMethod The contact's preferred method of communication.

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

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.

identification

{
  "type": "taxId",
  "value": "111-11-1111",
  "expiration": {}
}

Identification

Official identifying information associated with the contact.

Properties

Name	Description
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. Enumerated values: taxId passportNumber
expiration	string(date) The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.

preferredContactMethod

"unknown"

Preferred Contact Method

The contact's preferred method of communication.

Type: string
Enumerated values:
unknown
sms
email
other
notApplicable

outputs

{
  "token": "string"
}

Outputs

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.

fraudRiskReportState

"passed"

Fraud Risk Report State

The state of a fraud report. passed indicates that the provided personally identifiable information (PII) was located and contains no risk factors. passedWithRiskFactors means that the provided PII matches an identity but contains risk factors. failed means that the provided PII does not match any identity records.

Type: string
Enumerated values:
passed
passedWithRiskFactors
failed

fraudRiskCategory

{
  "type": "personalInfoDoesNotMatch",
  "description": "The retrieved identity does not match the provided PII.",
  "message": "ZIP code located does not match the ZIP code submitted."
}

Fraud-risk Category

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.
message	string The original result message that was received from the identity verification provider.

newAccountAvailability

"available"

New Account Availability (v1.0.0)

Describes if the product is available for opening new accounts.

newAccountAvailability strings may have one of the following enumerated values values (described by the named newAccountAvailability)

These enumeration values are further described by the label group named newAccountAvailability in the response from the getLabels operation.

Value	Description
available	Users may open new accounts of this type
notAvailable	Users may not open new accounts of this type

This schema is version v1.0.0.

Type: string
Enumerated values:
available
notAvailable

rate

{
  "value": "1.40",
  "type": "apr"
}

Interest Rate (v1.0.0)

The interest rate of the account. For deposit accounts, this is the rate of return; for loan accounts, this is the interest rate charged on balances. Rates can be absolute, such as "1.40" to indicate 1.4%, which is expressed as { "value" : "1.40" }, or relative to a benchmark, such as U.S. Prime Rate + 0.5% which is expressed as { "benchmark" : "prime", "value" : "0.50" }.

This schema is version v1.0.0.

Properties

Name	Description
value	string The rate, expressed as an decimal percentage string in order to represent the rate exactly. This number must have 2 to four decimal points, i.e. '2.00' or '0.50' or '1.015', but not 2 or .5. (Regular expression pattern: -?\d{1,3}+\.\d{2,4})
benchmark	string An optional base benchmark that the rate is relative to. If omitted, the rate is fixed. Otherwise the rate is added to the benchmark rate. Values may be (but are not limited to): primeUS - the U.S. Prime rate treasuryUS - The U.S. Treasury rate libor - the London Inter-bank Offered Rates rate
compoundPeriod	string The period at which interest compounds. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. The default is "P0D" (continuous).
accrualType	accrualType Indicates how interest is accrued according to the compoundPeriod.
adjustmentPeriod	string The period at which the rate is adjusted or recomputed to account for differences in the benchmark rate. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days; The default is "P1D" (daily).
type	interestRateType The interest rate type.

productTarget

"personal"

Product Target (v1.0.0)

The target audience for this product.

productTarget strings may have one of the following enumerated values values (described by the named productTarget)

These enumeration values are further described by the label group named productTarget in the response from the getLabels operation.

Value	Description
personal	Banking products for personal use
business	Banking products for business use

This schema is version v1.0.0.

Type: string
Enumerated values:
personal
business

typedEmailAddress

{
  "value": "JohnBankCustomer@example.com",
  "type": "unknown",
  "_id": "ha3"
}

Email Address

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	emailType The kind of email address.
_id	string An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$

profileItemState

"approved"

Organization Profile Item State

The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state pending, which means approval by the financial institution is pending. After they have been verified, the state becomes approved. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). pending items may not be assigned as the preferred item.

Type: string
Enumerated values:
pending
approved

approvalTypeFields

{
  "name": "governmentId",
  "label": "Government Issued ID",
  "description": "A document that identifies a user. `governmentId` approvals may not be waived or canceled.",
  "disallowedStates": [
    "waived",
    "canceled"
  ],
  "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement"
}

Approval Type Fields

Common fields of the approval resource used to build other model schemas.

Properties

Name	Description
name	string The approval's name.
label	string The approval's common name.
description	string The approval's description.
domain	string A namespace for grouping related resources, to keep them separate from other resources. For example, a department or bank branch may define a domain, and all Approval Type instances they define will use that domain, so that they can avoid conflicting with Approval Type names in other domains. An API or service may define a domain for new Approval Types that it defines. The combination of domain and name must be unique within the set of all approval types. It is a best practice to define domain with a URI or a URN.
disallowedStates	[disallowedState] An optional array of states that are not allowed for this approval type. If omitted, all state transitions are allowed. The states open and approved are always allowed, so this enumeration set is a subset of the approvalState enumeration on an approval.

kycAnswers

{
  "citizen": true,
  "permanentResident": true,
  "w9Withholdings": true,
  "employmentStatus": "unknown",
  "foreignPoliticalFigure": false,
  "countryPoliticalFigure": "string",
  "familyOfPoliticalFigure": true,
  "foreignPoliticalFigureCountry": "st",
  "foreignPoliticalFigureAssociation": "unknown"
}

Know Your Customer Answers

Answers to 'Know Your Customer' questions which allow financial institutions to conform to a customer identification program.

Properties

Name	Description
citizen	boolean true if the person is a citizen of the country in which the financial institution is doing business.
permanentResident	boolean true if the person is a permanent resident of the country in which the financial institution is doing business.
w9Withholdings	boolean true if the person is a subject to backup W-9 Tax Withholdings.
employmentStatus	employmentStatus The employment status of the person.
foreignPoliticalFigure	boolean true if the person is a foreign senior political figure. Default: false
countryPoliticalFigure	string If the person is a foreign senior political figure, this is the foreign country. This field is omitted if foreignPoliticalFigure is false.
familyOfPoliticalFigure	boolean true if the person is an immediate family member or a close associate of political figure.
foreignPoliticalFigureCountry	string If the person is a foreign senior political figure, this is the foreign country ISO 3166-1 country code. This field is omitted if foreignPoliticalFigure is false. maxLength: 2
foreignPoliticalFigureAssociation	foreignPoliticalFigureAssociation The type of association to a foreign political figure.

transactionTypes

{}

Transaction Types (v1.0.0)

An array which lists which transaction types are allowed for an account.

This schema is version v1.0.0.

transactionTypes is an array schema.

Array Elements

approvalFields

{
  "state": "active",
  "done": true,
  "label": "Government Issued ID",
  "typeName": "governmentId",
  "description": "A document that identifies a user",
  "reviewedBy": "/users/users/0399abed-fd3d-4830-a88b-30f38b8a365c",
  "reviewedAt": "2018-04-17T10:12:58.375Z"
}

Approval Fields

Common fields of the approval resource, used to define other model schemas.

Properties

Name	Description
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	approvalState The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type. read-only
done	boolean If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable. read-only
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.

consentFields

{
  "document": {
    "uri": "http://example.com",
    "contentType": "application/pdf",
    "revisionId": "2019:1.2.0",
    "revisedAt": "2020-05-21T14:05:13Z"
  },
  "type": "string",
  "contextUri": "http://example.com",
  "userId": "string"
}

Consent Fields

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(uri) 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. maxLength: 2048
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

The state of a consent resource.

Type: string
Enumerated values:
pending
given
stale
rescinded
revoked

verificationToken

{
  "token": "string"
}

Verification Token

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.

fraudRiskCategoryType

"ipRestricted"

Fraud Risk Category Type

Represents the possible types of fraud-risk.

Type: string
Enumerated values:
ipRestricted
identityOnGovernmentWatchlist
identityOnAlertList
addressIsPOBoxOrNonApproved
addressIsHighRisk
ageRestricted
nonStandardTaxId
personalInfoDoesNotMatch
emailRestricted

emailType

"unknown"

Email Type

The kind of email address.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the emailType label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
personal
work
school
other
notApplicable

phoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "555-555-5555"
}

Phone Number

A phone number and its role.

Properties

Name	Description
type	phoneNumberType (required) The type or role of this phone number.
number	string (required) The phone number, as a string. minLength: 8 maxLength: 16
label	string A text label, suitable for presentation to the end user. This is also used if type is other. maxLength: 32
_id	string An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$

organizationType

{}

Organization Type

The primary organization type.

Properties

organizationSubtype

{}

Organization Subtype

A refinement of the organization type.

Properties

organizationIdentification

{
  "value": "string",
  "type": "taxId",
  "expiresOn": "2020-05-21",
  "expiration": "2020-05-21"
}

Organization Identification

The type and value of the organizations unique identification numbers.

Properties

Name	Description
value	string (required) The value of this form of identification (the tax ID as a string, for example)
type	organizationIdentificationType (required) The type of this form of identification. taxId is the only supported type at this time.
expiresOn	string(date) The date when this form of identification expires.
expiration	string(date) The date when this form of identification expires. Note This property is deprecated; use expiresOn.

organizationAddress

{
  "_id": "ha1",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
    }
  }
}

Organization Address

Representation of an organization's address resource.

Properties

Name	Description
type	addressType The type of this address.
label	string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
_id	string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.

organizationPhoneNumber

{
  "_id": "hp1",
  "_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
  "type": "home",
  "number": "555-555-5555",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  }
}

Phone Number

Representation of phone number resources.

Properties

Name	Description
type	phoneNumberType The type or role of this phone number.
number	string The phone number, as a string. minLength: 8 maxLength: 16
label	string A text label, suitable for presentation to the end user. This is also used if type is other. maxLength: 32
_id	string An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.

organizationEmailAddress

{
  "_id": "pe1",
  "_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
  "type": "personal",
  "number": "555-555-5555",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "delete": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
    }
  }
}

Email Address

Representation of email address resources. An email address is immutable, although organizations can add new email addresses.

Properties

Name	Description
value	string(email) The email address, such as JohnBankCustomer@example.com minLength: 8 maxLength: 120
type	emailType The kind of email address.
_id	string An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array. minLength: 1 maxLength: 8 pattern: ^[-a-zA-Z0-9_]{1,8}$
_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 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.
state	profileItemState The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.

disallowedState

"rejected"

Disallowed State

A disallowed state for an approval. Approvals of this type may not be set to any of the states defined by this.

Type: string
Enumerated values:
rejected
waived
returned
canceled

accrualType

"compounding"

Accrual Type (v1.0.0)

Indicates how interest is accrued according to the compoundPeriod.

accrualType strings may have one of the following enumerated values values (described by the named accrualType)

These enumeration values are further described by the label group named accrualType in the response from the getLabels operation.

Value	Description
compounding	Compounding interest
simple	Simple interest

This schema is version v1.0.0.

Type: string
Enumerated values:
compounding
simple

interestRateType

"apr"

Interest Rate Type (v1.0.0)

The rate type. The rate type may not be changed once it is set at product creation. Rate types are:

• apr - annual percentage rate
• apy - annual percentage yield

This schema is version v1.0.0.

Type: string
Enumerated values:
apr
apy

employmentStatus

"unknown"

Employment Status

The employment status of a contact, located in kycAnswers.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the employmentStatus label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
fullTime
partTime
paidLeave
retired
other
notApplicable

foreignPoliticalFigureAssociation

"unknown"

foreign Political Figure Association

The type of association to a foreign political figure. This eumeration is described by the foreignPoliticalFigureAssociation value from the getLabels operation.

Type: string
Enumerated values:
unknown
closeAssociate
familyMember
none
other
notApplicable

estimatedAnnualRevenue

"unknown"

Estimated Annual Revenue

The estimated annual revenue in USD.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the estimatedAnnualRevenue group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
under1Million
from1to10Million
from10to100Million
over100Million
other
notApplicable

intermediaryServices

"unknown"

Intermediary Services

The intermediary/non-bank financial institution services provided.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the intermediaryServices group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
accounting
fundsManagement
insurance
investment
legal
medical
notary
realEstate
taxPreparation
trustManagement
gambling
securities
loanFinance
pawnBrokerage
travelAgency
vehicleSales
foreignCurrency
preciousMetals
other
notApplicable

regulatoryValue

{}

Regulatory Value

The value associated with this regulatory property.

Properties

addressType

"unknown"

Address Type

The type of a postal address.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the addressType label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable

approvalState

"open"

Approval State

The approval's state.

• open Created but pending input subject to approval
• submitted Pending review by approver
• approved Approval granted
• rejected Approval denied
• waived Approval forgiven
• returned Approver returns approval for modification
• canceled Approval request withdrawn

This is an immutable and derived property. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval.

Type: string
Enumerated values:
open
submitted
approved
rejected
waived
returned
canceled

phoneNumberType

"unknown"

Phone Number Type

The type or role of this phone number.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the phoneNumberType label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
home
work
mobile
fax
other

organizationIdentificationType

"taxId"

Organization Identification Type

The type of the form of an organization's identification. taxId is the only supported type at this time.

Type: string
Enumerated values:
taxId
dunsNumber

prodState

"pending"

Product or Product Type State (v1.0.0)

The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

prodState strings may have one of the following enumerated values values (described by the named prodState)

These enumeration values are further described by the label group named prodState in the response from the getLabels operation.

Value	Description
pending	This product has been created in draft form but is not yet available
active	This product is active and available for use
inactive	This product is temporarily not available for use
removed	This product has been removed and is permanently not available for use

This schema is version v1.0.0.

Type: string
Enumerated values:
pending
active
inactive
removed

transactionType

"debit"

Transaction Type (v1.0.0)

A string which defines a transaction type allowed for an account.

• credit : Credits may be posted to this account, such as transfer funds to this external account.
• debit : Debits may be posted to this account, such as transfer funds from this external account. Labels and descriptions for the enumeration values are in the transactionType key in the response of the getLabels operation.

transactionType strings may have one of the following enumerated values values (described by the named transactionType)

These enumeration values are further described by the label group named transactionType in the response from the getLabels operation.

Value	Description
debit	A transaction which descreases an account's balance
credit	A transaction which increases an accounts's balance

This schema is version v1.0.0.

Type: string
Enumerated values:
debit
credit

citizenship

[
  {
    "countryCode": "US",
    "state": "citizen"
  }
]

Citizenship

Citizenship or nationality status.

citizenship is an array schema.

Array Elements

Name	Description
countryCode	string (required) The ISO 3166-1 country code for the individual's citizenship. minLength: 2 maxLength: 2
state	string (required) The individual's citizenship status. Enumerated values: citizen other

residencyStatus

"unknown"

Residency

Residency status.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the residencyStatus label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
resident
nonresident
residentAlien
nonresidentAlien
other
notApplicable

occupation

"unknown"

Occupation

The person's occupation.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the occupation label group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
architectureAndEngineering
artsDesignEntertainmentSportsAndMedia
buildingAndGroundsCleaningAndMaintenance
businessAndFinancialOperations
communityAndSocialService
computerAndMathematical
constructionAndExtraction
educationTrainingAndLibrary
farmingFishingAndForestry
foodPreparationAndServingRelated
healthcarePractitionersAndTechnical
healthcareSupport
installationMaintenanceAndRepair
legal
lifePhysicalAndSciences
management
militarySpecific
officeAndAdministrativeSupport
personalCareAndService
production
protectiveServices
salesAndRelated
transportationAndMaterialMoving
other
notApplicable

yearsAtAddress

"unknown"

Years at Address

Categories for how long the person has been at their present home address.

Type: string
Enumerated values:
unknown
oneOrFewer
two
three
fourOrMore