Nothing Found

Request client redirect URL or password token

By default, generates a temporary page that allows a user to visit and have a browser session set. This is typically the first step in directing the user to a Tilia web UI, such as those presented in the payments or payouts flows. After calling this endpoint, redirect the client's browser to the URL in the response payload. More info about the web UI can be found here.

Alternatively, if return_token is set to true, the response payload will contain the key token whose value is a password token string that can be passed directly to other API calls. This is useful for clients that are not browser-based.

Securitytilia_auth
Request
Request Body schema: application/json
optional
account_id
required
string <= 36 characters

The customer's Tilia account_id

return_token
boolean

If true, a Tilia oauth token will be returned in the response payload rather than a URL redirect. Defaults to false.

mechanism
string

JWT created for the account_id supplied in the request body. NOTE: this only works if the mechanism is tilia_hosted.

flow
string

Indicates which pub hosting flow to use. NOTE: this only works if the mechanism is tilia_hosted.

token_expiration_seconds
string

An optional field indicating how long, in seconds, the token lastes

Responses
200

Success.

400

Invalid input. Invalid JSON in request body, or account_id is invalid

401

Unauthorized access.

403

Access forbidden. The account is blocked.

500

Service unavailable or server error

post/authorize/user
Request samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "return_token": true,
  • "mechanism": "tilia_hosted",
  • "flow": "addcard",
  • "token_expiration_seconds": 30
}
Response samples
application/json
{}