Viso.li

Create Account

POSThttps://www.viso.li/api/account/register

Creates an account for a name and email, then emails a 6-digit verification code. This call does not sign the user in and does not return an API key.

The name is 2–50 characters and may contain only letters and spaces.

This endpoint does not use an API key. Requests are limited by client IP.

Request body

Send a JSON object.

Fields

FieldTypeDescription
namestringRequired. Display name. 2–50 characters. Letters and spaces only.
emailstringRequired. Address that receives the verification code. Max 125 characters.

Example request

This creates an account for ada@example.com and emails a verification code.

1curl -X POST https://www.viso.li/api/account/register \
2 -H "Content-Type: application/json" \
3 -d '{
4 "name": "Ada Lovelace",
5 "email": "ada@example.com"
6}'

Success response

Returns 201 Created. The account still needs the emailed code. This response does not include a session or an API key.

response.json
1{
2 "email": "ada@example.com",
3 "verificationRequired": true
4}

Response fields

FieldTypeDescription
emailstringRequired. Address the verification code was sent to.
verificationRequiredbooleanRequired. The account still needs the emailed code.

Errors

StatusErrorDescription
400Bad RequestThe body is not JSON, or the name or email fails validation.
409ConflictAn account with this email already exists.
429Too Many RequestsMore than 2 requests per minute or 5 requests per day from this IP. The response includes a Retry-After header.
500Internal Server ErrorUnexpected server error. Retry the request.