Generate VOE - Payroll Report
POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/voePayroll
Premium Service: A billable event when the API response is successful.
MVS Implementation Options: Direct API Integration.
Used as a complementary report to the VOIE-Payroll report. This report is used 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.
To generate this report, pass the values from the customer SSN
, DOB
, and the reportId
from the first VOIE-Payroll report generated after the Connect session.
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
{"payrollData"=>{"ssn"=>"999601111", "dob"=>15983999}, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Finicity-App-Token | string | ||
Finicity-App-Key | string |