---
title: "Ask for an account and a key for the person you work for"
method: POST
path: "/signup"
tags: ["Account"]
---

# Ask for an account and a key for the person you work for

`POST /signup`

## Request

- Base URL: `https://api.scrapefield.com/v1`
- URL: `https://api.scrapefield.com/v1/signup`
- Auth: none required

No key needed. We email the person a link; they sign in and type `user_code`, which you show them. Then poll `GET /signup` with `id` as the bearer token. An account an agent starts has no free credits.

## Request body

- object
  - `email` string, email, required: The person's address. The account is theirs.
  - `agent` string: What you are called, as they know you: shown to them in the email.

## Response `202`

The request, waiting for the person.

- object
  - `data` object
    - `id` string, required: A secret worth a key: send it as the bearer token of `GET /signup`, never in a URL.
    - `user_code` string, required: Show this to the person: they type it to approve you.
    - `status` 'pending', required
    - `expires_at` string, date-time, required
    - `retry_after` integer: Seconds to wait between polls.
    - `next` string

## Other responses

- `400`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `403`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `500`: Something went wrong. `error.code` is stable; `error.message` says what to do next.

---

[API](https://skmtc.dev/scrapefield/apis/scrapefield-api.md) · [All operations](https://skmtc.dev/scrapefield/apis/scrapefield-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapefield/apis/scrapefield-api/revisions/cc5961ac63cf?raw)