Generate VOE - Payroll Report

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

Generate or refresh a VOE – Payroll report. Often used as a complementary report to the VOIE-Payroll report to fulfill the pre-close VOE requirements. It retrieves the customer's employment details and employment status through the payroll source without any income information.

This is a premium service. The billable event is the successful generation of a VOE - 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