REST API · Account and sign-up
Start a sign-up
https://platform.casafari.com/v1/signupsNo 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.
emailstring (email)requiredterms_versionstringrequiredaccount_namestringclientobject3 properties
namestringrequiredversionstringurlstring (uri)tips_opt_outbooleannews_opt_inbooleanExample 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.
Show the response shape (6 fields)
signup_idstringrequiredstatus"code_sent"requireddelivery"email"expires_atstring (date-time)verify_urlstring (uri)requiredterms_urlstring (uri)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)