Generate Connect URL - Joint Borrower
POST {{baseUrl}}/connect/v2/generate/jointBorrower
Same as Connect Full (POST /connect/v2/generate
) but for joint borrowers.
MVS prompts both the primary and joint borrower to enter each of their financial, payroll, and paystub information in the same Connect session.
Supported regions:
Request Body
{"partnerId"=>"{{partnerId}}", "language"=>"en", "borrowers"=>[{"customerId"=>"{{customerId}}", "consumerId"=>"0bf46322c167b562e6cbed9d40e19a4c", "type"=>"primary", "optionalConsumerInfo"=>{"ssn"=>"999999999", "dob"=>1607450357}}, {"customerId"=>"{{customerId}}", "consumerId"=>"0bf46322c167b562e6cbed9d40e19a4c", "type"=>"jointBorrower", "optionalConsumerInfo"=>{"ssn"=>"999999999", "dob"=>1607450357}}], "redirectUri"=>"https://www.finicity.com/connect/", "webhookContentType"=>"application/json", "webhookData"=>{}, "webhookHeaders"=>{}, "institutionSettings"=>{}, "fromDate"=>1607450357, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}], "singleUseUrl"=>true}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Finicity-App-Token | string | ||
Finicity-App-Key | string |
RESPONSES
status: OK
{"link":"https://connect2.finicity.com?customerId=5025024821\u0026institutionId=102105\u0026origin=url\u0026partnerId=2445583925753\u0026signature=b5667164db7a9a0007b59267785c996ca3bc9ce97f2e72c98099cead76edfad9\u0026timestamp=1648050761908\u0026ttl=1648057961908\u0026type=lite\u0026webhookContentType=application%2Fjson"}