Generate VOIE - Paystub Report

POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/voieTxVerify/withStatement

Generate a VOIE - Paystub report. This service uses the provided paystub(s), which are passed into the request body as asset IDs (generated using the Store Customer Pay Statement API) to generate the VOIE - Paystub report with digitized paystub details.

This is a premium service. The billing rate is the variable rate for VOIE - Paystub under the current subscription plan. The billable event is the successful generation of a VOIE - Paystub Report.

Supported regions: πŸ‡ΊπŸ‡Έ

Request Params

KeyDatatypeRequiredDescription
callbackUrlstringA Report Listener URL to receive notifications. The webhook must respond to the Finicity API with 2xx HTTP status code.

Request Body

{"voieWithStatementData"=>{"assetIds"=>["{{assetId}}"], "extractEarnings"=>true, "extractDeductions"=>true, "extractDirectDeposit"=>true}, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring
Finicity-App-Tokenstring
Finicity-App-Keystring