FousDocs

Connect a website account

Start a website sign-in, obtain the required account-risk authorization and relay each sign-in step to the account holder.

POST/v1/connections/attempts

Starts a sign-in to the website on Fous’s own server, the same way Studio’s Connections page does. The attempt comes back working; read it with wait until it reaches challenge, then show the person the form and submit what they typed. Show the ConnectRiskAcknowledgment notice and obtain explicit authorization for each connection or reconnection before sending consent and risk_acknowledgment. Never infer permission from a task request. Needs connections:write.

Requires Authorization: Bearer $FOUS_API_KEY. Create a key.

Request body

Required. JSON.

  • website_urlstringrequired
  • labelstring

    Defaults to the site.

  • consenttruerequired
  • risk_acknowledgmentConnectRiskAcknowledgment

    Required once a managed Connect notice is active. A missing or outdated acknowledgment returns 409 risk_acknowledgment_required with the exact current notice in error.details.notice. Present its full text and affirmation, obtain explicit authorization, and send its version with accepted: true. API and agent callers attest that they obtained permission; they must not silently accept for the person.

  • connection_idstring

    Sign in again for this existing connection.

  • fresh_loginboolean

    Start from a blank browser instead of what the website remembers.

Response 200

Success

  • successtruerequired
  • dataConnectionAttemptrequired

    One sign-in, step by step. challenge: the website asks for something, described in form; submit the answers. working: wait. verified: confirm it. ready: the account is connected. failed: notice says why, can_retry whether another method can be tried.

Errors

Every failure is an Error: branch on error.code. The errors guide lists each code.

  • 400
  • 401WWW-Authenticate
  • 402
  • 403
  • 404
  • 408
  • 409
  • 410
  • 413
  • 422
  • 429Retry-After
  • 500
  • 502
  • 503Retry-After
  • 504