Shell HTTP JavaScript Node.JS Ruby Python Java Go

Account Applications v0.17.9

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:

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:

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 type values described below. See Errors for more information on error responses and error types.

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 [string] 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 [string] 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:

Terms of service

Email: Apiture Web: Apiture

Authentication

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

StatusDescription
200 OK
OK
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getBlockedApplications

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/blockedApplications \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/accountApplications/blockedApplications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/blockedApplications',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/blockedApplications', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of blocked account applications

GET /blockedApplications

Return a paginated sortable filterable searchable collection of active running account applications. The links in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is blocked.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of account application representations to return in this page.
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

StatusDescription
200 OK
OK
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getApplications

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/applications', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of account applications

GET /applications

Return a paginated sortable filterable searchable collection of account applications. The links in the response include pagination links. Not all nested objects are supported for filtering or sorting applications. The following fields may be used: accountName, applicantName, productName, organizationName', state, createdAt, completedAt`

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of account application representations to return in this page.
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

StatusDescription
200 OK
OK
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createApplication

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/applications \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
  "accountName": "My checking account",
  "_links": {
    "apiture:product": {
      "href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "applicants": [
    {
      "username": "Snowqueen123",
      "contact": {
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "_links": {
          "self": {
            "href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
          }
        }
      },
      "role": {
        "name": "primaryUser",
        "label": "Primary User",
        "_links": {
          "self": {
            "href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
          }
        }
      }
    }
  ],
  "products": [
    {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/applications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/applications', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create a new account application

POST /applications

Create a new account application. This also creates and starts the workflow that is associated with the primary banking product in the request body. The client should execute any interactive workflow tasks until the workflow reaches a terminal state and the system approves or rejects the application or the user cancels the application. Users can have only one running application at a time.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json",
  "accountName": "My checking account",
  "_links": {
    "apiture:product": {
      "href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "applicants": [
    {
      "username": "Snowqueen123",
      "contact": {
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "_links": {
          "self": {
            "href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
          }
        }
      },
      "role": {
        "name": "primaryUser",
        "label": "Primary User",
        "_links": {
          "self": {
            "href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
          }
        }
      }
    }
  ],
  "products": [
    {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  ]
}

Parameters

Parameter Description
body
(body)
createApplication (required)
The data necessary to create a new account application.

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

StatusDescription
201 Created
Created
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK
Schema: application
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
204 No Content
No Content. The resource was deleted successfully.
StatusDescription
409 Conflict
Conflict. An application not be deleted by the applicant if the state is anything other than pending, or by the financial institution if the state is expired.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Account Application Actions

Operations to update the state of an application

expireApplication

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/expiredApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Expire an application

POST /expiredApplications

Update an application by adding it to the set of expired applications. This changes the state property of the application to expired. This operation is available via the apiture:expire link on the application resource, if and only if the application is eligible for the expire operation. The response is the updated representation of the application. The If-Match request header value, if passed, must match the current entity tag value of the application.

This operation is valid if the current state of the application is running, or blocked. This operation does nothing if the state is already expired. This is a terminal state: the application state cannot be changed once it has expired.

Parameters

Parameter Description
application
(query)
string (required)
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
If-Match
(header)
string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

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

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to expired.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to rejected.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to approved.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to canceled.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to running.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
200 OK
OK
Schema: enrollments
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createEnrollment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/enrollments \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/accountApplications/enrollments HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "property1": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    },
    "property2": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ]
}';
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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ]
}

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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19T15:31:18Z",
  "completedAt": "2020-06-19T15:31:18Z",
  "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-06-19",
      "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

StatusDescription
201 Created
Created
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse

Response Headers

StatusDescription
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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19T15:31:18Z",
  "completedAt": "2020-06-19T15:31:18Z",
  "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-06-19",
      "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

StatusDescription
200 OK
OK
Schema: enrollment
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19T15:31:18Z",
  "completedAt": "2020-06-19T15:31:18Z",
  "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-06-19",
      "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

StatusDescription
200 OK
OK
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19",
      "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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19T15:31:18Z",
  "completedAt": "2020-06-19T15:31:18Z",
  "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-06-19",
      "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

StatusDescription
200 OK
OK
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

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

Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
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

StatusDescription
204 No Content
No Content. The resource was deleted successfully.

Enrollment Actions

Operations which act on enrollments

rejectEnrollment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
  method: 'post',
  data: '?enrollment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
  params: {
  'enrollment' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments', params={
  'enrollment': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Reject an enrollment

POST /rejectedEnrollments

Reject an enrollment. This changes the state property of the enrollment to rejected. This operation is available via the apiture:reject link on the enrollment resource, if and only if the enrollment is eligible for the reject operation. The response is the updated representation of the enrollment. The If-Match request header value, if passed, must match the current entity tag value of the enrollment.

This operation is valid if the current state of the enrollment is running, or blocked. This operation does nothing if the state is already rejected. This is a terminal state: the enrollment state cannot be changed once it has been rejected. Only service or administrator can call this operation, not end users.

Parameters

Parameter Description
enrollment
(query)
string (required)
A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
If-Match
(header)
string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

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-06-19",
        "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-06-19T15:31:18Z"
    }
  ],
  "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-06-19T15:31:18Z",
  "completedAt": "2020-06-19T15:31:18Z",
  "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-06-19",
      "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

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to rejected.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment.

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

Schema: errorResponse
StatusDescription
409 Conflict
Conflict. The request to reject the enrollment is not allowed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
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