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.
Supported regions:
Request Body
{"partnerId"=>"{{partnerId}}", "customerId"=>"{{customerId}}", "language"=>"en", "consumerId"=>"0bf46322c167b562e6cbed9d40e19a4c", "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}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Finicity-App-Key | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{"link":"https://connect2.openbanking.mastercard.com.au?customerId=1892\u0026origin=url\u0026partnerId=2445583947972\u0026signature=54bfc4fdb002921f6066195bfbfd997934618caef61139cf8809bf6a4daa53e9\u0026timestamp=1656519867660\u0026ttl=1656527067660\u0026webhookContentType=application%2Fjson"}