Skip to main content
POST
/
v1
/
connections
Create a connection
curl --request POST \
  --url https://api.waycore.com/v1/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "institutionId": "<string>",
  "name": "<string>",
  "metadata": {}
}
'
{
  "connection": {
    "id": "<string>",
    "institutionId": "<string>",
    "status": "active",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "institutionName": "<string>",
    "lastSyncedAt": "2023-11-07T05:31:56Z",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "metadata": {}
  },
  "meta": {
    "requestId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0 Client Credentials issuing JWT Bearer access tokens.

Body

application/json
institutionId
string
required

Waycore's canonical institution identifier.

name
string | null

Optional human-readable label for this connection.

metadata
Metadata · object

Opaque client-defined metadata.

Response

Successful Response

connection
Connection · object
required
meta
Meta · object
required