Link authentication

This endpoint provides an alternative way of initializing the connection flow using our Link solution, as explained in this page. You can indicate the Link parameters using this endpoint to receive a JWT that can be used in the Link flow, so that you can avoid starting the Link with parameter values and instead just pass down the generated auth token. Using this flow is mandatory if you want to limit the owners in the Assets Transfer Flow.

Start connection flow

post

Retrieves a JWT token to start a connection flow in the Link with the indicated parameters

Authorizations

Body

Request to start a widget flow from the API side

entitystring | nullableOptional

Unique identifier of the financial entity to connect to (e.g., 'santander', 'bbva')

Example: santander

productstring · enumRequired

Type of financial data to extract from the connection

Example: TRANSACTIONSPossible values:

subproductstring · enum | nullableOptional

Subtype of the product for more specific data extraction. Only required for ASSETS_TRANSFER product, else it should be null

Example: FUNDPossible values:

externalIdstring | nullableOptional

External identifier to group multiple connections under the same reference. It might be something like a customer id or a user id

Example: customer-123

desiredOwnersstring[] | nullableOptional

List of desired owners for assets transfer operations (only applicable for ASSETS_TRANSFER product). It will mark as non-transferable those positions which owners are similar to the ones in the list

Example: ["John Doe","Jane Smith"]

idstring · uuidRequired

UUID of the app redirect configuration that determines where the widget will redirect after completion

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Successfully started connection flow

application/json

400

Invalid product and subproduct combination

application/json

401

Invalid credentials

application/json

403

Product not contracted by the organization

application/json

404

Invalid redirect ID - the specified ID does not correspond to a valid redirect configuration

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/commands/connections/start-flow HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "entity": "santander",
  "product": "TRANSACTIONS",
  "subproduct": "FUND",
  "externalId": "customer-123",
  "desiredOwners": [
    "John Doe",
    "Jane Smith"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "authToken": "text",
  "maintenance": true
}