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

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://api.synci.io/oauth/authorize

Token URL: https://api.synci.io/oauth/token

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠403AuthorizationException

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.synci.io/api/v1/users//portal-sessions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data ''

Response Example

200 - Example 1

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

Modified at 2026-08-31 06:19:01

Mint a token pair

List your users' financial connections