Skip to main content
GET
Get an onboarding attempt

How it works

Read an attempt’s state while you wait for the connection.created webhook: pending means the person hasn’t verified yet, converted means they have (and user_id is present), expired means the link died unused, and exchanged tells you whether the grant was already collected. Only the client that created the attempt can read it; anything else answers the same 404 as an unknown id.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Path Parameters

id
string
required

The attempt id from the create response.

Response

The attempt.