> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bringin.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get onboarding status

Poll onboarding status for a user. Use this if you don't have webhooks.

Requires your **master api-key**. No HMAC needed.

<ParamField query="email" type="string" required>
  The user's email address
</ParamField>

<ResponseExample>
  ```json Still onboarding (200) theme={null}
  {
    "status": "onboarding",
    "kycStatus": "PENDING_REVIEW"
  }
  ```

  ```json Connected (200) theme={null}
  {
    "status": "connected",
    "apiKey": "ZTY3YzNhMzQ3Yzk4NGJjMmEwZWU1NTQ4NmE5MjJjZTk="
  }
  ```

  ```json Pending consent (200) theme={null}
  {
    "status": "pending"
  }
  ```

  ```json Rejected (200) theme={null}
  {
    "status": "rejected"
  }
  ```
</ResponseExample>

| `status`     | Meaning                   | What to do                |
| ------------ | ------------------------- | ------------------------- |
| `onboarding` | Signup / KYC in progress  | Keep polling every 15-30s |
| `pending`    | Consent email sent        | Keep polling              |
| `connected`  | Ready — `apiKey` returned | Store it, stop polling    |
| `rejected`   | KYC rejected              | Show error to user        |