API reference / Connected account

Connect an account by signing in

Written and maintained by The ProspectAPIs team

POST/v1/accounts/login

POST /v1/accounts/login is the ProspectAPIs operation connectAccountLogin, in the Connected account group of the REST API. Connect your own account by signing in with its email or phone and password. When the account asks for a two-factor code, an emailed code or a check a person must finish, the answer is a 409 with a challenge_id (and a handoff_url for a check); send the same request again with code and challenge_id within 15 minutes. On success the session is stored exactly as with POST /v1/accounts/session: encrypted, used only for the actions you request, deleted when you disconnect. Free. Rate limit: 10 connect or sign-in attempts a minute per account. Cost: free; connect by signing in, with a code or a check when the account asks. 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 (AccountLoginRequest). Connect by signing in. Unless remember is true, the password is used for this sign-in only. When the account asks for a code or a check, send the same request again with code and the challenge_id from the 409. With totp_secret the two-factor code is typed for you; with remember: true a later sign-out is signed back in automatically.

{
  "identifier": "jane@example.com",
  "password": "your-password"
}

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. What is connected, never the session. 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/login \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "identifier": "jane@example.com", "password": "your-password" }'

const res = await fetch("https://api.prospectapis.com/v1/accounts/login", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "identifier": "jane@example.com",
    "password": "your-password"
  }),
});
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/login",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={
        "identifier": "jane@example.com",
        "password": "your-password",
    },
    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 by signing in, with a code or a check when the account asks. 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: Disconnect the account. Next operation: List conversations (live). 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).