Generate VOA Report
POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/voa
Generate a Verification of Assets (VOA) report for all checking, savings, money market, and investment accounts for the given customer. This service retrieves up to twelve months of transaction history for each account and uses this information to generate the VOA report.
This is a premium service. The billing rate is the variable rate for Verification of Assets under the current subscription plan. The billable event is the successful generation of a VOA report.
A report consumer must be created for the given customer before calling this API (see Consumers
).
If no account of type checking, savings, money market, or investment is found, the service will return HTTP 400 Bad Request.
Supported regions:
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
callbackUrl | string | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with 2xx HTTP status code. |
Request Body
{"reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}], "showNsf"=>false}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Finicity-App-Token | string | ||
Finicity-App-Key | string |