v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB
Connections

Search institution connections

Retrieve institution connections filtered by various parameters.

get/bank-linking/connections

Query parameters

customerIdstring

Meld generated unique identifier for your customer. This should be used to track customer activity.

externalCustomerIdstring

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

institutionIdstring

Institution id. If present, only institution connections with this institution will be included.

statusesstring

Comma separated list of institution connection statuses. If present, only institution connections with these statuses will be included.

Find out more about connection statuses here.

serviceProvidersstring

Comma separated list of service providers. If present, only institution connections with these service providers will be included.

Note: Reference Supported Service Providers for the list of available bank linking providers.

startDatestring

Start date to begin search from of format yyyy-mm-dd

endDatestring

End date stop search on of format yyyy-mm-dd

beforestring

Unique key corresponding to an institution connection's position in the paginated list of results -- used to indicate that only institution connections residing before this key will be retrieved.

Each institution connection carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

afterstring

Unique key corresponding to a institution connection's position in the paginated list of results -- used to indicate that only institution connections residing after this key will be retrieved.

Each institution connection carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

limitstring

Limits number of returned institution connections.

Default value: 10

Minimum value: 1

Maximum value: 100

institutionNamestring

Institution name. If present, only institution connections with this institution will be included.If institutionId is present then institutionId will take precedence.

Response

Connections are returned