API reference / Connected account

Create a hosted connect link

Written and maintained by The ProspectAPIs team

POST/v1/accounts/connect-link

POST /v1/accounts/connect-link is the ProspectAPIs operation createAccountConnectLink, in the Connected account group of the REST API. A short-lived, single-use URL on our site where your end user connects their own account: a sign-in with any code or check it asks for, or a session string. You never handle the password. Refused while connecting accounts is unavailable. Free. Cost: free; a single-use link where your end user connects their own account, with signed account events. 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 (ConnectLinkRequest). Every field is optional. A create link connects a new account; a reconnect link reconnects the account it names and keeps its account_id.

{}

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.

201 response fields

The link. url and webhook_secret are shown only here. The body is a ConnectLink.

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/connect-link \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch("https://api.prospectapis.com/v1/accounts/connect-link", {
  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/connect-link",
    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: a single-use link where your end user connects their own account, with signed account events. 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: Your post insights (live). Next operation: Revoke a hosted connect link. 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).