Generate V2 Connect URL Links

The Connect 2.0 endpoints generate Connect URL links that you use in your own applications. You can choose from the following Connect 2.0 APIs. If you don’t want to send a Connect URL through the API, you can send an email instead.

To change the look and behavior of Connect according to your business needs, configure the experience parameter used in all generate Connect URL APIs. See Configure Connect Experience

The following options allow you to generate different types of Connect URL links:

The Full version of Connect and Connect Full with MVS includes the following features:

  • Sign in, the user’s credentials, and Multi-Factor Authentication (MFA).
  • Search for the user’s financial institutions.
  • Manage the user’s accounts.
Generate V2 Connect URL (Connect Full)
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/generate' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "customerId": "1005061234",

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "experience": "default",

  "fromDate": 1607450357,

  "reportCustomFields": [

    {

      "label": "loanID",

      "value": "12345",

      "shown": true

    },

    {

      "label": "branchID",

      "value": "55555",

      "shown": false

    }

  ]

}'
APIGenerate V2 Connect URL (Connect Full)
Generate V2 Connect URL - Joint Borrower
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/generate/jointBorrower' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "borrowers": [

    {

      "customerId": "1005061234",

      "consumerId": "1973f901305e2ab3ba8840f411f6b057",

      "type": "primary",

      "optionalConsumerInfo": {

        "ssn": "123412134",

        "dob": "315576000"

      }

    },

    {

      "customerId": "1005063558",

      "consumerId": "1973f901305e2ab3ba8840f41112asdf9f",

      "type": "jointBorrower",

      "optionalConsumerInfo": {

        "ssn": "351225513",

        "dob": "625726800"

      }

    }

  ],

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "experience": "default",

  "fromDate": 1607450357,

  "reportCustomFields": [

    {

      "label": "loanID",

      "value": "12345",

      "shown": true

    },

    {

      "label": "branchID",

      "value": "55555",

      "shown": false

    }

  ]

}'
APIGenerate V2 Connect URL - Joint Borrower

Connect Lite is a variation of Connect Full, which has a limited set of features.

  • Sign in, user’s credentials, and Multi-Factor Authentication (MFA).
  • No user account management.

The Connect Web SDK isn’t a requirement when using Connect lite. However, if you want to use the SDK events, routes, and user events, then you need to integrate with the Connect Web SDK.

Recommendation: Use our Connect Best Practices to get the most out of Connect Lite.

Generate V2 Lite Connect URL
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/generate/lite' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "customerId": "1005061234",

  "institutionId": 101723,

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "experience": "default"

}'
APIGenerate V2 Lite Connect URL

Use the connect fix endpoint when the following conditions occur:

  • The connection to the user’s financial institution is lost.
  • The user’s credentials were updated (for any number of reasons).
  • The user’s MFA challenge has expired.
Generate V2 Fix Connect URL
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/generate/fix' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "customerId": "1005061234",

  "institutionLoginId": 13556634,

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "experience": "default",

  "singleUseUrl": true

}'
APIGenerate V2 Fix Connect URL

Rather than sending a Connect URL through the API, you can send an email to the consumer, including a Connect link. The email includes a button that opens the Connect application.

Send V2 Connect Email
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/send/email' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "customerId": "1005061234",

  "consumerId": "86238nvnw7269e224a4e3de12352d87d",

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "email": {

    "to": "fin.user@finicity.com",

    "from": "testLender@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"

    ]

  },

  "experience": "default",

  "fromDate": 12345678,

  "reportCustomFields": [

    {

      "label": "loanID",

      "value": "12345",

      "shown": true

    },

    {

      "label": "branchID",

      "value": "55555",

      "shown": false

    }

  ],

  "singleUseUrl": true

}'
APISend V2 Connect Email
Send V2 Connect Email - Joint Borrower
 curl -X POST \

  --url 'https://api.finicity.com/connect/v2/send/email/jointBorrower' \

  -H 'Finicity-App-Token: Finicity-App-Token'\

  -H 'Finicity-App-Key: Finicity-App-Key'\

  -H 'Accept: application/json' \

  -H 'Content-type: application/json' \

  --data-raw '{

  "partnerId": "1445585709680",

  "borrowers": [

    {

      "customerId": "1005061234",

      "consumerId": "1973f901305e2ab3ba8840f411f6b057",

      "type": "primary",

      "optionalConsumerInfo": {

        "ssn": "123412134",

        "dob": "315576000"

      }

    },

    {

      "customerId": "1005063558",

      "consumerId": "1973f901305e2ab3ba8840f41112asdf9f",

      "type": "jointBorrower",

      "optionalConsumerInfo": {

        "ssn": "351225513",

        "dob": "625726800"

      }

    }

  ],

  "webhook": "https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b",

  "webhookContentType": "application/json",

  "email": {

    "to": "fin.user@finicity.com",

    "from": "testLender@test.com",

    "supportPhone": "800-555-5555",

    "subject": "Verify your assets, income and employment",

    "firstName": "Marvin and Jenny",

    "institutionName": "Acme Lending",

    "institutionAddress": "222 Winipeg Drive SLC UT, 84109",

    "signature": [

      "Cindy Mayfield",

      "Senior Loan Officer",

      "Direct 123-456-7890"

    ]

  },

  "experience": "default",

  "fromDate": 12345678,

  "reportCustomFields": [

    {

      "label": "loanID",

      "value": "12345",

      "shown": true

    },

    {

      "label": "branchID",

      "value": "55555",

      "shown": false

    }

  ],

  "singleUseUrl": true

}'
APISend V2 Connect Email - Joint Borrower