Skip to content
Purser

Create Connection

POST
/connections
curl --request POST \
  --url https://example.com/connections \
  --header 'Content-Type: application/json' \
  --data '{ "setup_token": "example" }'

Exchange a one-time SimpleFIN setup token; the access URL is stored encrypted and never returned.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ConnectionCreate
object
setup_token
required
Setup Token
string

Example generated

{
  "setup_token": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
ConnectionOut
object
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
last_fetch_at
required
Any of:
string format: date-time
provider
required
Provider
string
status
required
Status
string

Example generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "last_fetch_at": "2026-04-15T12:00:00Z",
  "provider": "example",
  "status": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}