Generate VOIE - Payroll Report

POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/voiePayroll

Generate or refresh a VOIE – Payroll report. For clients using the product via a consumer permissioning experience via Connect, the original VOIE – Payroll report generates when the consumer completes the Connect experience, and this API is only used for future report refreshes without reengaging the consumer.

This is a premium service. The billable event is the successful generation of a VOIE - Payroll report.

Supported regions: πŸ‡ΊπŸ‡Έ

Request Params

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

Request Body

{"payrollData"=>{"ssn"=>"999601111", "dob"=>15983999}, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}]}

HEADERS

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