Generate Connect URL

POST {{baseUrl}}/connect/v2/generate

Generate a Connect 2.0 URL link to add within your own applications.

Use the experience parameter to call Connect (per session) in the body of the request. Configure the experience parameter to change the brand color, logo, icon, which credit decisioning report to generate when the Connect application completes, and more.

Note: contact your Sales Account Team to set up the experience parameter.

MVS Developers: You can pre-populate the consumer's SSN on the Find employment records page at the beginning of the MVS payroll app. Pass the SSN value for the consumer in the body of the request call.

Supported regions:

Request Body

{"partnerId"=>"{{partnerId}}", "customerId"=>"{{customerId}}", "language"=>"en", "consumerId"=>"0bf46322c167b562e6cbed9d40e19a4c", "redirectUri"=>"https://www.finicity.com/connect/", "webhookContentType"=>"application/json", "optionalConsumerInfo"=>{"ssn"=>"999999999", "dob"=>1607450357}, "singleUseUrl"=>true, "fromDate"=>1607450357, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>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"}