Send Connect Email - Joint Borrower

POST {{baseUrl}}/connect/v2/send/email/jointBorrower

Same as Connect Joint Borrower (POST /connect/v2/generate/jointBorrower) but send a Connect email to at least one of the joint borrower's email addresses.

When the consumer opens the email, 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}}], "email"=>{"to"=>"alex.salido@finicity.com", "supportPhone"=>"800-555-5555", "subject"=>"Verify your income", "firstName"=>"Bob", "institutionName"=>"Acme Lending", "institutionAddress"=>"222 Winipeg Drive SLC UT, 84109", "signature"=>["Cindy Mayfield", "Senior Loan Officer", "Direct 123-456-7890"]}, "redirectUri"=>"https://www.finicity.com/connect/", "webhookContentType"=>"application/json", "fromDate"=>1607450357, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}], "singleUseUrl"=>true}

HEADERS

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","emailConfig":{"to":"alex.salido@finicity.com","from":"test.lender@test.com","supportPhone":"800-555-5555","subject":"Verify your income","firstName":"Bob","institutionName":"Acme Lending","institutionAddress":"222 Winipeg Drive SLC UT, 84109","signature":["Cindy Mayfield","Senior Loan Officer","Direct 123-456-7890"]}}