Create a portal session

POST

/users/{userId}/portal-sessions

Returns a single-use URL that drops this user straight into the connection
portal with no sign-in code — use it when they are already authenticated in
your own app. Valid once, for a short window.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠403AuthorizationException

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.synci.io/managed/v1/users/6bfbe0a6-2d49-4dc8-b983-fb4dfa417ea0/portal-sessions' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "return_url": "http://example.com"
}'

Response Example

200 - Example 1

{
    "data": {
        "url": "string",
        "expires_at": "string"
    }
}

Modified at 2026-09-01 00:17:55

Mint a token pair

List your users' financial connections