Start a sign-up

No key needed: this is how a person or an agent opens an account and gets its first API key. See platform API keys.

Over MCP: no tool does this.

#Description

Emails a 6-digit code to the person. Entering it accepts the terms and opens a Free plan account.

#Request body

Content type application/json. Required. Type: object.

#Example request

Placeholders only: replace the token and the values with your own.

curl -X POST "https://platform.casafari.com/v1/signups" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "<email>",
  "terms_version": "<terms_version>"
}'

#Responses

#202 Code sent.

Type: object.

#Errors

Every error is an application/problem+json body (RFC 9457) with type (a page that explains it), title, status, detail (what to do), instance, code and request_id (what to quote to support). A 402 carries an upgrade_url, a 429 a Retry-After header. The codes each status can carry:

• 400 invalid_request, email_not_allowed, terms_not_accepted, verification_code_invalid, verification_code_expired (https://platform.casafari.com/errors/invalid-request, https://platform.casafari.com/errors/email-not-allowed, https://platform.casafari.com/errors/terms-not-accepted, https://platform.casafari.com/errors/verification-code-invalid, https://platform.casafari.com/errors/verification-code-expired)
• 404 not_found (https://platform.casafari.com/errors/not-found)
• 405 method_not_allowed (https://platform.casafari.com/errors/method-not-allowed)
• 429 signup_limited, rate_limited (https://platform.casafari.com/errors/signup-limited, https://platform.casafari.com/errors/rate-limited)
• 500 internal_error (https://platform.casafari.com/errors/internal-error)
• 503 unavailable (https://platform.casafari.com/errors/unavailable)

#Related pages

• Account status: plan, tokens and limits (GET /v1/account)
• Status of a payment link (GET /v1/account/payment-links/{payment_link_id})
• Read the current terms (GET /v1/signups/terms)
• Finish a sign-up with the emailed code (POST /v1/signups/{signup_id}/verify)
• Account and sign-up REST API: all operations
• How to get a bearer token for the Casafari REST API
• MCP vs REST API compared