Send Connect Email

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

Same as Connect Full (POST /connect/v2/generate) but send a Connect email to a consumer.

Supported regions: πŸ‡ΊπŸ‡Έ

Request Body

{"partnerId"=>"{{partnerId}}", "customerId"=>"{{customerId}}", "language"=>"en", "consumerId"=>"0bf46322c167b562e6cbed9d40e19a4c", "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", "singleUseUrl"=>true, "fromDate"=>1607450357, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}], "optionalConsumerInfo"=>{"ssn"=>"999999999", "dob"=>1607450357}}

HEADERS

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

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"]}}