External Account Verification

API

getApi

Top-level resources and operations in this API

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


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/"
import { APIApi } from "@apiture/external_account_verification-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/apiDoc"
import { APIApi } from "@apiture/external_account_verification-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


AccountVerification

createInstantVerification

Create a new instant verification resource

This type of verification requires to send encrypted login fields to initiate an authentication process with the external financial institution. A `GET` to `/institutions/{institutionId}/authenticationFields` must be executed to retrieve the required login fields. 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.


/instantVerifications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountVerifications/instantVerifications"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.createInstantVerification()
var createInstantVerification = ; // {CreateInstantVerification} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.createInstantVerification(createInstantVerification, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Body parameters
Name Description
createInstantVerification *

The data necessary to create a new account verification.

Responses

Name Type Format Description
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.
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`


createMicroDepositVerification

Create a new micro-deposit verification resource

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


/microDepositVerifications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.createMicroDepositVerification()
var createMicroDepositVerification = ; // {CreateMicroDepositVerification} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.createMicroDepositVerification(createMicroDepositVerification, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Body parameters
Name Description
createMicroDepositVerification *

The data necessary to create a new account verification.

Responses

Name Type Format Description
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.
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`.


getInstantVerification

Fetch a representation of this instant verification resource

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this account verification resource.


/instantVerifications/{verificationId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/instantVerifications/{verificationId}"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getInstantVerification()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getInstantVerification(verificationId, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
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 instant verification resource.


getInstantVerificationAccounts

Returns a collection of external accounts related to this verification resource

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.


/instantVerifications/{verificationId}/accounts

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/instantVerifications/{verificationId}/accounts?unmasked="
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getInstantVerificationAccounts()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var opts = {
  'unmasked': true // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getInstantVerificationAccounts(verificationId, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Query parameters
Name Description
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.

Responses


getInstantVerifications

Return a collection of instant verifications

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of account verifications. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/instantVerifications

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/instantVerifications?start=&limit=&sortBy=&filter=&q=&externalAccount="
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getInstantVerifications()
var opts = {
  'start': 789, // {Long} The zero-based index of the first instant verification item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of instant verification representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'externalAccount': externalAccount_example // {String} Return verifications for the external account identified by this query parameter. The value is the unique `_id` or URL of an external account.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getInstantVerifications(opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first instant verification item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of instant verification representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
externalAccount
String
Return verifications for the external account identified by this query parameter. The value is the unique `_id` or URL of an external account.

Responses


getMicroDepositVerification

Fetch a representation of this micro-deposit verification resource

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this account verification resource.


/microDepositVerifications/{verificationId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications/{verificationId}"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getMicroDepositVerification()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getMicroDepositVerification(verificationId, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
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 institution resource.


getMicroDepositVerificationAccounts

Returns a collection of external accounts related to this verification resource

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


/microDepositVerifications/{verificationId}/accounts

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications/{verificationId}/accounts"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getMicroDepositVerificationAccounts()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getMicroDepositVerificationAccounts(verificationId, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required

Responses


getMicroDepositVerifications

Return a collection of micro-deposit verification resources

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of micro-deposit verifications. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/microDepositVerifications

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications?start=&limit=&sortBy=&filter=&q=&externalAccount="
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.getMicroDepositVerifications()
var opts = {
  'start': 789, // {Long} The zero-based index of the first institution item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of institution representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'externalAccount': externalAccount_example // {String} Return verifications for the external account identified by this query parameter. The value is the unique `_id` or URL of an external account.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.getMicroDepositVerifications(opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first institution item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of institution representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
externalAccount
String
Return verifications for the external account identified by this query parameter. The value is the unique `_id` or URL of an external account.

Responses


patchMicroDepositVerification

Update this micro-deposit verification resource

Perform a partial update of this micro-deposit verification resource. To associate this account verification with an external account resource, include an `apiture:externalAccount` link inside the `_links` collection, with the link's `href` set to that external account's URL.


/microDepositVerifications/{verificationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications/{verificationId}"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.patchMicroDepositVerification()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var microDepositVerification = ; // {MicroDepositVerification} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.patchMicroDepositVerification(verificationId, microDepositVerification, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
microDepositVerification *

The data necessary to update a micro-deposit verification resource.

Responses

Name Type Format Description
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 institution resource.


updateInstantVerification

Update this instant verification resource

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`. To associate this account verification with an external account resource, include an `apiture:externalAccount` link inside the `_links` collection, with the link's `href` set to that external account's URL.


/instantVerifications/{verificationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accountVerifications/instantVerifications/{verificationId}"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.updateInstantVerification()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var updateInstantVerification = ; // {UpdateInstantVerification} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.updateInstantVerification(verificationId, updateInstantVerification, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateInstantVerification *

The data necessary to update an instant verification resource.

Responses

Name Type Format Description
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 instant verification resource.


verifyMicroDepositAmounts

Verify micro-deposit amounts

Complete the verification by providing the amount values from the micro-deposit transactions.


/microDepositVerifications/{verificationId}

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountVerifications/microDepositVerifications/{verificationId}"
import { AccountVerificationApi } from "@apiture/external_account_verification-client-sdk";

const accountVerificationApi = new AccountVerificationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountVerificationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountVerificationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.AccountVerificationApi.verifyMicroDepositAmounts()
var verificationId = verificationId_example; // {String} The unique identifier of this account verificaton. This is an opaque string.
var microDepositVerificationAmounts = ; // {MicroDepositVerificationAmounts} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountVerificationApi.verifyMicroDepositAmounts(verificationId, microDepositVerificationAmounts, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
verificationId*
String
The unique identifier of this account verificaton. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
microDepositVerificationAmounts *

The amounts from a micro-deposit.

Responses

Name Type Format Description
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 institution resource.


Configuration

getConfiguration

Configuration definition for this API

Returns the configuration for this API


/configurations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfiguration()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfiguration(callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Responses


getConfigurationGroup

Fetch a representation of this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group resource.


/configurations/groups/{groupName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfigurationGroup()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroup(groupName, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-None-Match` request header for *`GET`* operations for this configuration group resource.


getConfigurationGroupSchema

Fetch the schema for this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group schema resource.


/configurations/groups/{groupName}/schema

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}/schema"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfigurationGroupSchema()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupSchema(groupName, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroupValue

Fetch a single value associated with the specified configuration group

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To update a specific value, use `PUT /accountVerifications/configurations/groups/{groupName}/values/{valueName}` (operation `updateConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValue(groupName, valueName, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


getConfigurationGroupValues

Fetch the values for the specified configuration group

Return a representation of this configuration group values resource.


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValues(groupName, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroups

Return a collection of configuration groups

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of configuration groups. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/configurations/groups

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups?start=&limit=&sortBy=&filter=&q="
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.getConfigurationGroups()
var opts = {
  'start': 789, // {Long} The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of configuration group representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroups(opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of configuration group representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


updateConfigurationGroupValue

Update a single value associated with the specified configuration group

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's `schema`. The request body must conform to the configuration group's schema for the named `{valueName}`. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To fetch specific value, use `GET /accountVerifications/configurations/groups/{groupName}/values/{valueName}` (operation `getConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.updateConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var body = body_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValue(groupName, valueName, body, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
body *

The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


updateConfigurationGroupValues

Update the values for the specified configuration group

Perform a complete replacement of this set of values


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accountVerifications/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/external_account_verification-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.ConfigurationApi.updateConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var configurationValues = ; // {ConfigurationValues} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValues(groupName, configurationValues, opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
configurationValues *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


Institutions

getInstitution

Fetch a representation of this external financial institution

Return a [HAL](https://developer.apiture.com/docs/concepts/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.


/institutions/{institutionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/institutions/{institutionId}"
import { InstitutionsApi } from "@apiture/external_account_verification-client-sdk";

const institutionsApi = new InstitutionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
institutionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
institutionsApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.InstitutionsApi.getInstitution()
var institutionId = institutionId_example; // {String} The unique identifier of this institution resource. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
institutionsApi.getInstitution(institutionId, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
institutionId*
String
The unique identifier of this institution resource. This is an opaque string.
Required

Responses

Name Type Format Description
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 institution resource.


getInstitutionFields

Return descriptions of the fields required to authenticate with the external institution

This endpoint returns descriptions of the fields required to authenticate with the external institution.


/institutions/{institutionId}/authenticationFields

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/institutions/{institutionId}/authenticationFields"
import { InstitutionsApi } from "@apiture/external_account_verification-client-sdk";

const institutionsApi = new InstitutionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
institutionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
institutionsApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.InstitutionsApi.getInstitutionFields()
var institutionId = institutionId_example; // {String} The unique identifier of this institution resource. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
institutionsApi.getInstitutionFields(institutionId, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Path parameters
Name Description
institutionId*
String
The unique identifier of this institution resource. This is an opaque string.
Required

Responses

Name Type Format Description
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 institution resource.


getInstitutions

Return a collection of institutions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/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](https://developer.apiture.com/docs/concepts/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`.


/institutions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountVerifications/institutions?start=&limit=&sortBy=&filter=&q=&name=&label="
import { InstitutionsApi } from "@apiture/external_account_verification-client-sdk";

const institutionsApi = new InstitutionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
institutionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
institutionsApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.InstitutionsApi.getInstitutions()
var opts = {
  'start': 789, // {Long} The zero-based index of the first institution item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of financial institution representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'name': name_example, // {String} Subset the institutions 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](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the institutions collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
institutionsApi.getInstitutions(opts, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first institution item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of financial institution representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
name
String
Subset the institutions 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](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the institutions collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


VerificationReport

createVerificationReport

Create a new verification report resource

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


/verificationReports

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountVerifications/verificationReports?verification="
import { VerificationReportApi } from "@apiture/external_account_verification-client-sdk";

const verificationReportApi = new VerificationReportApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
verificationReportApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
verificationReportApi.setApiKey(apiKey);


var api = new ExternalAccountVerification.VerificationReportApi.createVerificationReport()
var verification = verification_example; // {String} A string which identifies a specific verification resource. The value may be a `{verificationId}` or a verification URI.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
verificationReportApi.createVerificationReport(verification, callback);

Scopes

banking/read Read access to (behavior TBD).
banking/write Write (update) access to (behavior TBD).
banking/delete Delete access to (behavior TBD).
banking/full Full access to (behavior TBD).

Parameters

Query parameters
Name Description
verification*
String
A string which identifies a specific verification resource. The value may be a `{verificationId}` or a verification URI.
Required

Responses