API reference / Connected account

Connect another account

Written and maintained by The ProspectAPIs team

POST/v1/accounts

POST /v1/accounts is the ProspectAPIs operation addConnectedAccount, in the Connected account group of the REST API. Connect another of your own accounts to this key, alongside the ones already connected, with a session string or a sign-in. The account_id exists from the start, so a sign-in that asks for a code or a check answers 409 with account_id and challenge_id; finish it at POST /v1/accounts/{account_id}/checkpoint. Refused with 409 account_already_connected (and that account's account_id) when the same account is already connected, and 409 account_limit at 50 accounts. Free. Cost: free; connect another account (a session or a sign-in) and get its account_id. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the connected account API, with worked examples, is in the connected accounts guide.

Parameters

Request body

JSON (AddAccountRequest). Either a signed-in session (as POST /v1/accounts/session takes) or a sign-in (as POST /v1/accounts/login takes).

{}

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

201 response fields

Connected. The body is a ConnectedAccount.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl -X POST https://api.prospectapis.com/v1/accounts \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch("https://api.prospectapis.com/v1/accounts", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/accounts",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

The call itself is free, and what it sets up is billed as it runs: connect another account (a session or a sign-in) and get its account_id. Metered spend on the same key is reported after each response in X-Credits-Remaining, and GET /v1/account shows the balance at any time.

Related

The connected accounts guide covers this area end to end. Previous operation: List connected accounts. Next operation: Get one connected account. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).