---
title: "Auth link (GoCardLess)"
method: POST
path: "/auth/gocardless/link"
---

# Auth link (GoCardLess)

`POST /auth/gocardless/link`

## Request body

- GoCardLessLinkBodySchema
  - `institutionId` string, required
  - `redirect` string, required
  - `agreement` string, nullable, required
  - `reference` string

## Response `200`

Retrieve Link

- GoCardLessLinkSchema
  - `data` object, required
    - `link` string, required

## Other responses

- `400` — Returns an error

## Changes

- **2024-10-07** `8189c00a2b21` — 1 info
  - added the new optional request property `reference`
- **2024-07-24** `7a388bdc5a89` — 1 breaking, 1 warning
  - added the new required request property `institutionId`
  - removed the request property `institution_id`
- **2024-07-23** `1515e7c2644a` — 1 breaking, 1 warning
  - the `code` response's property type/format changed from `number`/`` to `string`/`` for status `400`
  - removed the optional property `details` from the response with the `400` status
- **2024-07-23** `85b4f43c2bb3` — 2 info
  - added the optional property `details` to the response with the `400` status
  - added the required property `requestId` to the response with the `400` status
- **2024-07-05** `b620765f2663` — 2 breaking, 1 warning, 1 info
  - added the new required request property `institution_id`
  - removed the required property `link` from the response with the `200` status
  - removed the request property `institutionId`
  - added the required property `data` to the response with the `200` status

[Full history](https://skmtc.dev/midday-ai/apis/midday-engine-api/changes/auth/gocardless/link/post.md)

---

[API](https://skmtc.dev/midday-ai/apis/midday-engine-api.md) · [All operations](https://skmtc.dev/midday-ai/apis/midday-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/midday-ai/midday-engine-api/revisions/bf3c1ab4d60d/schema)