Skip to main content
PUT
/
v1
/
connections
/
{connectionId}
/
setupCompletion
Complete Connection Setup
curl --request PUT \
  --url https://api.waycore.com/v1/connections/{connectionId}/setupCompletion \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "entityId": "<string>",
  "status": "draft",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "setup": {
    "status": "awaitingDelegatedUserCreation",
    "instructions": {
      "firstName": "Waycore",
      "lastName": "Service",
      "address": "12 New Fetter Lane, London, United Kingdom, EC4A 1JP",
      "email": "<string>",
      "username": "<string>",
      "phoneNumber": "<string>",
      "emailProvisioningStatus": "pending",
      "phoneNumberProvisioningStatus": "pending"
    },
    "credentialsPresent": true,
    "actionRequiredBy": "endUser",
    "nextAction": "createDelegatedUser"
  },
  "kind": "setup",
  "portalUrl": "<string>",
  "institutionId": "<string>",
  "institutionName": "<string>",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Path Parameters

​
connectionId
string
required

Response

Successful Response

​
id
string
required

Stable, immutable identifier for the connection.

​
entityId
string
required

Stable identifier for the entity that owns this connection.

​
status
enum<string>
required

Current connection status.

Available options:
draft,
pendingActivation,
active,
reauthRequired,
errored,
paused,
revoked
​
createdAt
string<date-time>
required

When the connection was created in this API.

​
updatedAt
string<date-time>
required

When the connection last changed in this API.

​
setup
SetupState · object
required
​
kind
string
default:setup

Delegated-user setup record for a connection that is not yet ready to operate.

Allowed value: "setup"
​
portalUrl
string | null

Normalized portal URL used as the connection anchor, when available.

​
institutionId
string | null

Waycore's canonical institution identifier, when already known.

​
institutionName
string | null

Institution display name, when available.

​
metadata
Metadata · object

Opaque client-defined metadata.