External Account Verification v0.1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This API allows financial institutions to verify their customer's external accounts. An external account is defined as a customer's account held at a different financial institution.

Two sets of operations can be utilized to accomplish the verification of an external account: instant verification and micro-deposit. Both operations are asynchronous, which means that upon resource creation the API will return a resource with state equal to pending. Once the verification completes, the state will be updated to verified or failed to indicate the result of the operation.

Instant Account Verification (IAV)

This process verifies accounts held at a financial institution within seconds by authenticating via user account credentials with the external financial institution and multi-factor challenges when available.

Micro-Deposit Verification (MD)

This is an alternative verification method for institutions that don't support IAV. When this verification is initiated, Apiture creates two deposits (typically less than $0.99) to the customer account to be verified, followed by a debit which balances those deposits. Once the transactions post to the user account, the account owner should find the deposits on their external account and submit the two amounts to the micro-deposits resources. This verifies that the user has ownership or access to the external account. Please note that the micro-deposit transactions may take up to two business days to be reflected on the external financial institution.

Download OpenAPI Definition (YAML)

Base URLs:

• /accountVerifications

Terms of service

Email: Apiture Web: Apiture

API

Endpoints which describe this API

getApi

Code samples

# You can also use wget
curl -X GET /accountVerifications/ \
  -H 'Accept: application/hal+json'

GET /accountVerifications/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/',
{
  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'
}

result = RestClient.get '/accountVerifications/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schema/apiRoot/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /accountVerifications/apiDoc \
  -H 'Accept: application/json'

GET /accountVerifications/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: '/accountVerifications/apiDoc',
  method: 'get',

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

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

const headers = {
  'Accept':'application/json'

};

fetch('/accountVerifications/apiDoc',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/accountVerifications/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/accountVerifications/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

Response Schema

Account Verification

Creation and retrieval of account verifications

getmicroDepositVerifications

Code samples

# You can also use wget
curl -X GET /accountVerifications/microDepositVerifications \
  -H 'Accept: application/hal+json'

GET /accountVerifications/microDepositVerifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/microDepositVerifications',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/microDepositVerifications',
{
  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'
}

result = RestClient.get '/accountVerifications/microDepositVerifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/microDepositVerifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/microDepositVerifications");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/microDepositVerifications", data)
    req.Header = headers

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

Return a collection of micro-deposit verification resources

GET /microDepositVerifications

Return a paginated sortable filterable searchable collection of micro-deposit verifications. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string",
  "_embedded": {
    "items": [
      {
        "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:externalAccounts": {
            "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
          },
          "apiture:verificationReport": {
            "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "state": "verified"
      }
    ]
  }
}

Responses

createMicroDepositVerification

Code samples

# You can also use wget
curl -X POST /accountVerifications/microDepositVerifications \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /accountVerifications/microDepositVerifications HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/microDepositVerifications',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "routingNumbers": {
    "full": "054100318"
  },
  "accountNumbers": {
    "full": "7432172992"
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/microDepositVerifications',
{
  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'
}

result = RestClient.post '/accountVerifications/microDepositVerifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/accountVerifications/microDepositVerifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/microDepositVerifications");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/accountVerifications/microDepositVerifications", data)
    req.Header = headers

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

Create a new micro-deposit verification resource

POST /microDepositVerifications

This operation is used to verify an account using micro-deposits. The verification must contain full unmasked account numbers.

Body parameter

{
  "routingNumbers": {
    "full": "054100318"
  },
  "accountNumbers": {
    "full": "7432172992"
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "verified"
}

Responses

Response Schema

Status Code 201

Response Headers

getMicroDepositVerification

Code samples

# You can also use wget
curl -X GET /accountVerifications/microDepositVerifications/{verificationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /accountVerifications/microDepositVerifications/{verificationId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/accountVerifications/microDepositVerifications/{verificationId}',
  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'

};

fetch('/accountVerifications/microDepositVerifications/{verificationId}',
{
  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'
}

result = RestClient.get '/accountVerifications/microDepositVerifications/{verificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/accountVerifications/microDepositVerifications/{verificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/microDepositVerifications/{verificationId}");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/microDepositVerifications/{verificationId}", data)
    req.Header = headers

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

Fetch a representation of this micro-deposit verification resource

GET /microDepositVerifications/{verificationId}

Return a HAL representation of this account verification resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "verified"
}

Responses

Response Schema

Status Code 200

Response Headers

patchMicroDepositVerification

Code samples

# You can also use wget
curl -X PATCH /accountVerifications/microDepositVerifications/{verificationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

PATCH /accountVerifications/microDepositVerifications/{verificationId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-None-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/accountVerifications/microDepositVerifications/{verificationId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "amount1": {
    "value": ".02",
    "currency": "USD"
  },
  "amount2": {
    "value": ".04",
    "currency": "USD"
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/accountVerifications/microDepositVerifications/{verificationId}',
{
  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-None-Match' => 'string'
}

result = RestClient.patch '/accountVerifications/microDepositVerifications/{verificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.patch('/accountVerifications/microDepositVerifications/{verificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/microDepositVerifications/{verificationId}");
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-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/accountVerifications/microDepositVerifications/{verificationId}", data)
    req.Header = headers

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

Update this micro-deposit verification resource

PATCH /microDepositVerifications/{verificationId}

Perform a partial update of this verification resource. This operation must be used to complete the verification by providing the amount values from the micro-deposit transactions.

Body parameter

{
  "amount1": {
    "value": ".02",
    "currency": "USD"
  },
  "amount2": {
    "value": ".04",
    "currency": "USD"
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "verified"
}

Responses

Response Schema

Status Code 200

Response Headers

getMicroDeposit_Ver_Accounts

Code samples

# You can also use wget
curl -X GET /accountVerifications/microDepositVerifications/{verificationId}/accounts \
  -H 'Accept: application/hal+json'

GET /accountVerifications/microDepositVerifications/{verificationId}/accounts HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/microDepositVerifications/{verificationId}/accounts',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/microDepositVerifications/{verificationId}/accounts',
{
  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'
}

result = RestClient.get '/accountVerifications/microDepositVerifications/{verificationId}/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/microDepositVerifications/{verificationId}/accounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/microDepositVerifications/{verificationId}/accounts");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/microDepositVerifications/{verificationId}/accounts", data)
    req.Header = headers

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

Returns a collection of external accounts related to this verification resource

GET /microDepositVerifications/{verificationId}/accounts

Once a verification is successful, this operation retrieves the accounts associated with it. The response includes the external account entities pertaining to the verification.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/externalAccount/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My account at 3rdParty Bank",
        "_profile": "http://api.apiture.com/schemas/externalAccount/v1.0.0/profile.json",
        "type": "savings",
        "state": "active",
        "primaryUserName": "Lucille Wellphunded",
        "institutionName": "3rdParty Bank",
        "verifiedAt": "2018-01-20T18:13:33.375Z",
        "createdAt": "2018-01-20T05:54:52.375Z",
        "routingNumber": "021000021",
        "accountNumbers": {
          "masked": "*************3210"
        },
        "transactionTypes": [
          "credit",
          "debit"
        ],
        "_links": {
          "self": {
            "href": "/accounts/externalAccounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      }
    ]
  }
}

Responses

Response Schema

Status Code 200

getInstantVerifications

Code samples

# You can also use wget
curl -X GET /accountVerifications/instantVerifications \
  -H 'Accept: application/hal+json'

GET /accountVerifications/instantVerifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/instantVerifications',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/instantVerifications',
{
  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'
}

result = RestClient.get '/accountVerifications/instantVerifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/instantVerifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/instantVerifications");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/instantVerifications", data)
    req.Header = headers

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

Return a collection of instant verifications

GET /instantVerifications

Return a paginated sortable filterable searchable collection of account verifications. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerifications/v1.0.0/profile.json"
}

Responses

createInstantVerification

Code samples

# You can also use wget
curl -X POST /accountVerifications/instantVerifications \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'Authentication: string'

POST /accountVerifications/instantVerifications HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
Authentication: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authentication':'string'

};

$.ajax({
  url: '/accountVerifications/instantVerifications',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authentication':'string'

};

fetch('/accountVerifications/instantVerifications',
{
  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',
  'Authentication' => 'string'
}

result = RestClient.post '/accountVerifications/instantVerifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'Authentication': 'string'
}

r = requests.post('/accountVerifications/instantVerifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/instantVerifications");
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"},
        "Authentication": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/accountVerifications/instantVerifications", data)
    req.Header = headers

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

Create a new instant verification resource

POST /instantVerifications

This type of verification requires the send user credentials as part of the Authentication header to initiate an authentication process with the external financial institution. This operation returns a verification resource with a pending status. In order to check for status updates, a client must continuously poll the resource via GET to the /instantVerifications endpoint.

Body parameter

{
  "_links": {
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contacts/ef039bdb-5605-4802-b163-d2f7cdbd28ab"
    },
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    }
  },
  "state": "pending",
  "mfaRequired": true,
  "mfaPrompt": null,
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "Send code to",
        "choices": [
          {
            "key": 1,
            "value": "Mobile XXX-XXX-9771"
          },
          {
            "key": 2,
            "value": "Mobile XXX-XXX-9881"
          }
        ]
      }
    ]
  }
}

Responses

Response Headers

getInstantVerification

Code samples

# You can also use wget
curl -X GET /accountVerifications/instantVerifications/{verificationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /accountVerifications/instantVerifications/{verificationId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/accountVerifications/instantVerifications/{verificationId}',
  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'

};

fetch('/accountVerifications/instantVerifications/{verificationId}',
{
  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'
}

result = RestClient.get '/accountVerifications/instantVerifications/{verificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/accountVerifications/instantVerifications/{verificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/instantVerifications/{verificationId}");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/instantVerifications/{verificationId}", data)
    req.Header = headers

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

Fetch a representation of this instant verification resource

GET /instantVerifications/{verificationId}

Return a HAL representation of this account verification resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contacts/ef039bdb-5605-4802-b163-d2f7cdbd28ab"
    },
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    }
  },
  "state": "pending",
  "mfaRequired": true,
  "mfaPrompt": null,
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "Send code to",
        "choices": [
          {
            "key": 1,
            "value": "Mobile XXX-XXX-9771"
          },
          {
            "key": 2,
            "value": "Mobile XXX-XXX-9881"
          }
        ]
      }
    ]
  }
}

Responses

Response Schema

Status Code 200

Response Headers

updateInstantVerification

Code samples

# You can also use wget
curl -X PATCH /accountVerifications/instantVerifications/{verificationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

PATCH /accountVerifications/instantVerifications/{verificationId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-None-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/accountVerifications/instantVerifications/{verificationId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerifications/v1.0.0/profile.json",
  "_links": {
    "apiture:institution": {
      "href": "/institutions/institutions/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "mfa": {
    "answers": [
      {
        "key": 1,
        "value": "Mobile XXX-XXX-9771"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/accountVerifications/instantVerifications/{verificationId}',
{
  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-None-Match' => 'string'
}

result = RestClient.patch '/accountVerifications/instantVerifications/{verificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.patch('/accountVerifications/instantVerifications/{verificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/instantVerifications/{verificationId}");
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-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/accountVerifications/instantVerifications/{verificationId}", data)
    req.Header = headers

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

Update this instant verification resource

PATCH /instantVerifications/{verificationId}

This operation must be used to update a verification resource waiting for user input, that is when the mfaRequired field is set to true and the state of the resource is pending.

Body parameter

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerifications/v1.0.0/profile.json",
  "_links": {
    "apiture:institution": {
      "href": "/institutions/institutions/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "mfa": {
    "answers": [
      {
        "key": 1,
        "value": "Mobile XXX-XXX-9771"
      }
    ]
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "pending",
  "mfaRequired": true,
  "mfaPrompt": null,
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "Input the received code"
      }
    ]
  }
}

Responses

Response Schema

Status Code 200

Response Headers

getInstantVerificationAccounts

Code samples

# You can also use wget
curl -X GET /accountVerifications/instantVerifications/{verificationId}/accounts \
  -H 'Accept: application/hal+json'

GET /accountVerifications/instantVerifications/{verificationId}/accounts HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/instantVerifications/{verificationId}/accounts',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/instantVerifications/{verificationId}/accounts',
{
  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'
}

result = RestClient.get '/accountVerifications/instantVerifications/{verificationId}/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/instantVerifications/{verificationId}/accounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/instantVerifications/{verificationId}/accounts");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/instantVerifications/{verificationId}/accounts", data)
    req.Header = headers

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

Returns a collection of external accounts related to this verification resource

GET /instantVerifications/{verificationId}/accounts

Once a verification is successful, this operation retrieves the accounts associated with it. The response includes an array of embeded external account entities pertaining to the verified FI account.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/externalAccount/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My account at 3rdParty Bank",
        "_profile": "http://api.apiture.com/schemas/externalAccount/v1.0.0/profile.json",
        "type": "savings",
        "state": "active",
        "primaryUserName": "Lucille Wellphunded",
        "institutionName": "3rdParty Bank",
        "verifiedAt": "2018-01-20T18:13:33.375Z",
        "createdAt": "2018-01-20T05:54:52.375Z",
        "routingNumber": "021000021",
        "accountNumbers": {
          "masked": "*************3210"
        },
        "transactionTypes": [
          "credit",
          "debit"
        ],
        "_links": {
          "self": {
            "href": "/accounts/externalAccounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      }
    ]
  }
}

Responses

Response Schema

Status Code 200

Verification Report

Generating reports of a verification resource

createVerificationReport

Code samples

# You can also use wget
curl -X POST /accountVerifications/verificationReports?verification=string \
  -H 'Accept: application/hal+json'

POST /accountVerifications/verificationReports?verification=string HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/verificationReports',
  method: 'post',
  data: '?verification=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/verificationReports?verification=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'
}

result = RestClient.post '/accountVerifications/verificationReports',
  params: {
  'verification' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.post('/accountVerifications/verificationReports', params={
  'verification': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/verificationReports?verification=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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/accountVerifications/verificationReports", data)
    req.Header = headers

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

Create a new verification report resource

POST /verificationReports

A verification report is an additional layer of validation that can be run against a verification resource. It uses available account aggregation data from an external provider to generate a pass/fail result based on pre-configured risk factors. This operation does not create a new persisent resource; the report is transient and returned in the response body only.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "state": "failed",
  "accountRiskFactors": [
    {
      "riskCode": 101,
      "description": "Account owner first name does not match"
    },
    {
      "riskCode": 102,
      "description": "Account owner last name does not match"
    },
    {
      "riskCode": 103,
      "description": "Account owner zip code does not match"
    }
  ]
}

Responses

Response Schema

Status Code 200

Enumerated Values

Institutions

Information about financial institutions

getInstitutions

Code samples

# You can also use wget
curl -X GET /accountVerifications/institutions \
  -H 'Accept: application/hal+json'

GET /accountVerifications/institutions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/institutions',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/institutions',
{
  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'
}

result = RestClient.get '/accountVerifications/institutions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/institutions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/institutions");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/institutions", data)
    req.Header = headers

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

Return a collection of institutions

GET /institutions

Return a paginated sortable filterable searchable collection of registered external financial institutions. This list is supplied by a third party and is immutable (there are no operations to add, modify, or remove institutions.) The links in the response include pagination links.

In adition to the standard sorting mechanisms, it is possible to sort institutions by popularity by using the popularity criteria, such as ?sortBy=popularity.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/externalInstitutions/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "external institutions",
  "_links": {
    "self": {
      "href": "/accountVerifications/institutions?start=10&limit=10"
    },
    "first": {
      "href": "/accountVerifications/institutions?start=0&limit=10"
    },
    "next": {
      "href": "/accountVerifications/institutions?start=20&limit=10"
    },
    "collection": {
      "href": "/accountVerifications/institutions"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "SunTrust Banks, Inc",
        "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
        "label": "Suntrust",
        "featured": true,
        "_links": {
          "self": {
            "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "icon": {
            "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
          },
          "home": {
            "href": "https://www.liveoak.bank/"
          }
        }
      },
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365d",
        "name": "Live Oak Bancshares, Inc.",
        "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
        "label": "Live Oak Bank",
        "featured": true,
        "_links": {
          "self": {
            "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "icon": {
            "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
          },
          "home": {
            "href": "https://www.liveoak.bank/"
          }
        }
      }
    ]
  }
}

Responses

getInstitution

Code samples

# You can also use wget
curl -X GET /accountVerifications/institutions/{institutionId} \
  -H 'Accept: application/hal+json'

GET /accountVerifications/institutions/{institutionId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/accountVerifications/institutions/{institutionId}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/accountVerifications/institutions/{institutionId}',
{
  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'
}

result = RestClient.get '/accountVerifications/institutions/{institutionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/accountVerifications/institutions/{institutionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/accountVerifications/institutions/{institutionId}");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accountVerifications/institutions/{institutionId}", data)
    req.Header = headers

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

Fetch a representation of this external financial institution

GET /institutions/{institutionId}

Return a HAL representation of this external financial institution resource.

The links in an institution may contain the following:

• home - Home URL of the financial website
• icon - URL referencing an institution icon. The possible image formats are SVG and PNG. # TODO: Pending yodlee to define sizes and/or aspect ratio

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "name": "Live Oak Bancshares, Inc.",
  "label": "Live Oak Bank",
  "featured": true,
  "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
    },
    "icon": {
      "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
    },
    "home": {
      "href": "https://www.liveoak.bank/"
    }
  }
}

Responses

Response Schema

Status Code 200

Response Headers

Schemas

institutions

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/externalInstitutions/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "external institutions",
  "_links": {
    "self": {
      "href": "/accountVerifications/institutions?start=10&limit=10"
    },
    "first": {
      "href": "/accountVerifications/institutions?start=0&limit=10"
    },
    "next": {
      "href": "/accountVerifications/institutions?start=20&limit=10"
    },
    "collection": {
      "href": "/accountVerifications/institutions"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "SunTrust Banks, Inc",
        "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
        "label": "Suntrust",
        "featured": true,
        "_links": {
          "self": {
            "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "icon": {
            "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
          },
          "home": {
            "href": "https://www.liveoak.bank/"
          }
        }
      },
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365d",
        "name": "Live Oak Bancshares, Inc.",
        "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
        "label": "Live Oak Bank",
        "featured": true,
        "_links": {
          "self": {
            "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
          },
          "icon": {
            "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
          },
          "home": {
            "href": "https://www.liveoak.bank/"
          }
        }
      }
    ]
  }
}

Institutions

Properties

allOf

and

institution

{
  "name": "Live Oak Bancshares, Inc.",
  "label": "Live Oak Bank",
  "featured": true,
  "_profile": "http://api.apiture.com/schemas/accountVerifications/institution/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/institution/0399abed-fd3d-4830-a88b-30f38b8a365d"
    },
    "icon": {
      "href": "http://d111111abcdef8.cloudfront.net/images/image2.jpg"
    },
    "home": {
      "href": "https://www.liveoak.bank/"
    }
  }
}

Institution

Properties

allOf

and

createMicroDepositVerification

{
  "routingNumbers": {
    "full": "054100318"
  },
  "accountNumbers": {
    "full": "7432172992"
  }
}

Create Micro Deposit Verification

Properties

Enumerated Values

updateMicroDepositVerification

{
  "amount1": {
    "value": ".02",
    "currency": "USD"
  },
  "amount2": {
    "value": ".04",
    "currency": "USD"
  }
}

Update Micro Deposits Verification

Properties

microDeposit

{
  "value": "string",
  "currency": "string"
}

Micro Deposit

Properties

microDepositVerification

{
  "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "verified"
}

Micro Deposit Verification

Properties

allOf

and

Enumerated Values

microDepositVerifications

{
  "_profile": "http://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string",
  "_embedded": {
    "items": [
      {
        "_profile": "http://api.apiture.com/accountVerifications/microDepositVerification/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:externalAccounts": {
            "href": "/accountVerifications/microDepositVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
          },
          "apiture:verificationReport": {
            "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "state": "verified"
      }
    ]
  }
}

Micro Deposit Verification Collection

Properties

allOf

and

instantVerificationFields

{}

Instant Verification Fields

Properties

No properties

instantVerification

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contacts/ef039bdb-5605-4802-b163-d2f7cdbd28ab"
    },
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    }
  },
  "state": "pending",
  "mfaRequired": true,
  "mfaPrompt": null,
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "Send code to",
        "choices": [
          {
            "key": 1,
            "value": "Mobile XXX-XXX-9771"
          },
          {
            "key": 2,
            "value": "Mobile XXX-XXX-9881"
          }
        ]
      }
    ]
  }
}

Instant Verification

Properties

allOf

and

and

Enumerated Values

updatedInstantVerification

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:externalAccounts": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    },
    "apiture:verificationReport": {
      "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "pending",
  "mfaRequired": true,
  "mfaPrompt": null,
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "Input the received code"
      }
    ]
  }
}

Instant Verification

Properties

allOf

and

and

summaryInstantVerification

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerification/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "apiture:externalAccounts": {
    "href": "/accountVerifications/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
  },
  "apiture:verificationReport": {
    "href": "/accountVerifications/verificationReports?verification=0399abed-fd3d-4830-a88b-30f38b8a365c"
  },
  "apiture:contact": {
    "href": "/contacts/contacts/ef039bdb-5605-4802-b163-d2f7cdbd28ab"
  },
  "apiture:institution": {
    "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
  },
  "state": "pending",
  "mfaRequired": true
}

Summary Instant Verification

Properties

allOf

and

and

Enumerated Values

instantVerifications

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerifications/v1.0.0/profile.json"
}

Instant Verification Collection

Properties

allOf

and

createInstantVerification

{
  "_links": {
    "apiture:institution": {
      "href": "/accountVerifications/institutions/961ffc1e-e1f1-11e8-8366-274c0a4e671e"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Create Instant Verification

Properties

allOf

and

updateInstantVerification

{
  "_profile": "http://api.apiture.com/schemas/accountVerifications/instantVerifications/v1.0.0/profile.json",
  "_links": {
    "apiture:institution": {
      "href": "/institutions/institutions/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:contact": {
      "href": "/contacts/contact/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "mfa": {
    "answers": [
      {
        "key": 1,
        "value": "Mobile XXX-XXX-9771"
      }
    ]
  }
}

Update Instant Verification

Properties

allOf

and

mfaPrompt

{
  "questions": {
    "question": [
      {
        "key": 1,
        "type": "TEXT",
        "value": "What is the name of your state?",
        "choices": [
          {
            "key": 1,
            "value": "North Carolina"
          },
          {
            "key": 2,
            "value": "South Carolina"
          }
        ]
      },
      {
        "key": 2,
        "type": "TEXT",
        "value": "Send code to",
        "choices": [
          {
            "key": 1,
            "value": "Mobile XXX-XXX-9771"
          },
          {
            "key": 2,
            "value": "Mobile XXX-XXX-9881"
          }
        ]
      },
      {
        "key": 3,
        "type": "TEXT",
        "value": "Input the received code"
      }
    ]
  }
}

MFA Challenge

Properties

questionFields

{
  "key": "string"
}

MFA Question Fields

Properties

question

{
  "key": "string",
  "content": "string",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "choices": [
    {
      "type": "IMAGE",
      "key": 0,
      "value": "string",
      "content": "string",
      "_links": {
        "property1": {
          "href": "http://example.com",
          "type": "string",
          "templated": true,
          "title": "string",
          "deprecation": "http://example.com",
          "profile": "http://example.com"
        },
        "property2": {
          "href": "http://example.com",
          "type": "string",
          "templated": true,
          "title": "string",
          "deprecation": "http://example.com",
          "profile": "http://example.com"
        }
      }
    }
  ],
  "type": "QUESTION",
  "value": "string"
}

MFA Question

Properties

allOf

and

Enumerated Values

questionResponse

{
  "title": "MFA Answer",
  "description": "Representation of a multi-factor authentication question answer.",
  "type": "array",
  "required": [
    "value"
  ],
  "allOf": [
    {
      "title": "MFA Question Fields",
      "description": "Common question and answer fields.",
      "required": [
        "key"
      ],
      "properties": {
        "key": {
          "type": "string"
        }
      }
    },
    {
      "type": "array",
      "properties": {
        "value": {
          "type": "string"
        }
      },
      "items": {}
    }
  ],
  "items": {}
}

MFA Answer

Properties

allOf

and

choice

{
  "type": "IMAGE",
  "key": 0,
  "value": "string",
  "content": "string",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  }
}

MFA Choice

Properties

Enumerated Values

mfaResponse

{
  "title": "MFA Response",
  "description": "Representation of a multi-factor authentication response.",
  "allOf": [
    {
      "type": "object"
    },
    {
      "properties": {
        "answers": {
          "title": "MFA Answer",
          "description": "Representation of a multi-factor authentication question answer.",
          "type": "array",
          "required": [
            "value"
          ],
          "allOf": [
            {
              "title": "MFA Question Fields",
              "description": "Common question and answer fields.",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string"
                }
              }
            },
            {
              "type": "array",
              "properties": {
                "value": {
                  "type": "string"
                }
              },
              "items": {}
            }
          ],
          "items": {}
        }
      }
    }
  ]
}

MFA Response

Properties

allOf

and

externalAccounts

{
  "_profile": "http://api.apiture.com/schemas/collection/externalAccount/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/instantVerifications/0399abed-fd3d-4830-a88b-30f38b8a365c/accounts"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My account at 3rdParty Bank",
        "_profile": "http://api.apiture.com/schemas/externalAccount/v1.0.0/profile.json",
        "type": "savings",
        "state": "active",
        "primaryUserName": "Lucille Wellphunded",
        "institutionName": "3rdParty Bank",
        "verifiedAt": "2018-01-20T18:13:33.375Z",
        "createdAt": "2018-01-20T05:54:52.375Z",
        "routingNumber": "021000021",
        "accountNumbers": {
          "masked": "*************3210"
        },
        "transactionTypes": [
          "credit",
          "debit"
        ],
        "_links": {
          "self": {
            "href": "/accounts/externalAccounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      }
    ]
  }
}

External Account Collection

Properties

allOf

and

verificationReport

{
  "state": "failed",
  "accountRiskFactors": [
    {
      "riskCode": 101,
      "description": "Account owner first name does not match"
    },
    {
      "riskCode": 102,
      "description": "Account owner last name does not match"
    },
    {
      "riskCode": 103,
      "description": "Account owner zip code does not match"
    }
  ]
}

Verification Report

Properties

Enumerated Values

riskFactor

{
  "riskCode": "string",
  "description": "string",
  "attributes": {
    "value": "string",
    "expected": [
      "string"
    ]
  }
}

Risk Factor

Properties

riskFactorAttributes

{
  "value": "string",
  "expected": [
    "string"
  ]
}

Risk Factor Attributes

Properties

summaryExternalAccount

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/externalAccount/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/accounts/externalAccounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "state": "active",
  "verifiedAt": "2018-01-20T18:13:33.375Z",
  "createdAt": "2018-01-20T05:54:52.375Z",
  "routingNumber": "021000021",
  "institutionName": "3rd Party Bank"
}

External Account Summary

Properties

allOf

and

Enumerated Values

accountNumbers

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

Account Numbers

Properties

collection

{
  "_profile": "http://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

Properties

allOf

and

abstractResource

{
  "_profile": "http://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource

Properties

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schema/apiRoot/v1.0.0/profile.json",
  "_links": {}
}

API Root

Properties

allOf

and

errorResponse

{
  "_profile": "http://api.apiture.com/schema/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schema/error/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

Properties

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "_profile": "https://api.apiture.com/schema/error/v1.0.0/profile.json",
  "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": "http://doc.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

Properties

attributes

{}

Attributes

Properties

No properties

links

{
  "property1": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  },
  "property2": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  }
}

Links

Properties

link

{
  "href": "http://example.com",
  "type": "string",
  "templated": true,
  "title": "string",
  "deprecation": "http://example.com",
  "profile": "http://example.com"
}

Link

Properties