> ## Documentation Index > Fetch the complete documentation index at: https://bavlio.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Start a registration > Creates an ephemeral account and an API key for it, without any credentials. Given an email address, it also sends the verification email that makes the account permanent; without one, claim the registration later. Starts are rate limited per IP address. ## OpenAPI ```json { "openapi": "3.2.0", "info": { "title": "Bavlio API", "version": "1.0.0" }, "paths": { "/registrations": { "post": { "tags": [ "Registration" ], "operationId": "registration.startRegistration", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "registration": { "type": "object", "properties": { "id": { "type": "string", "description": "Registration id, used to get or claim the registration." }, "status": { "type": "string", "enum": [ "awaiting_email", "awaiting_verification", "verified" ], "description": "awaiting_email until an email address is given, awaiting_verification once the verification email is sent, verified once the address is confirmed and the account is active." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email address being verified; null until one is given." }, "verification_sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the last verification email was sent, as an ISO 8601 timestamp; null if none was sent." }, "expires_at": { "type": "string", "description": "When the registration expires, as an ISO 8601 timestamp. An account still unverified by then is due for deletion." }, "account": { "type": "object", "properties": { "id": { "type": "string", "description": "Account id; team endpoints call it account_id." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account's email address; null when none is known yet." }, "status": { "type": "string", "enum": [ "ephemeral", "active" ], "description": "ephemeral while the email address is unverified and the account is temporary; active once the address is verified and the account is permanent." }, "created_at": { "type": "string", "description": "When the account was created, as an ISO 8601 timestamp." }, "verified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the email address was verified, as an ISO 8601 timestamp; null while the account is ephemeral." } }, "required": [ "id", "email", "status", "created_at", "verified_at" ], "additionalProperties": false, "description": "The account the registration created." } }, "required": [ "id", "status", "email", "verification_sent_at", "expires_at", "account" ], "additionalProperties": false }, "api_key": { "type": "string", "description": "Secret of the API key created for the new account, returned only in this response. Send it as the bearer token." } }, "required": [ "registration", "api_key" ], "additionalProperties": false } } } }, "400": { "description": "RequestInvalidBody", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInvalidBodyEncoded" } } } }, "409": { "description": "RegistrationEmailTaken", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailTakenEncoded" } } } }, "429": { "description": "RequestRateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimitedEncoded" } } } }, "502": { "description": "RegistrationNotStarted | RegistrationEmailNotSent", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationNotStartedEncoded" }, { "$ref": "#/components/schemas/RegistrationEmailNotSentEncoded" } ] } } } } }, "description": "Creates an ephemeral account and an API key for it, without any credentials. Given an email address, it also sends the verification email that makes the account permanent; without one, claim the registration later. Starts are rate limited per IP address.", "summary": "Start a registration", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to send the verification email to now. Leave it out to claim the registration with an address later." } }, "additionalProperties": false } } }, "required": true } } } }, "components": { "schemas": { "RequestInvalidBodyEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestInvalidBody" ] }, "statusCode": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "invalid_body" ] }, "message": { "type": "string" } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "RequestRateLimitedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestRateLimited" ] }, "statusCode": { "type": "number", "enum": [ 429 ] }, "code": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" }, "retryAfterSeconds": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "_tag", "statusCode", "code", "message", "retryAfterSeconds" ], "additionalProperties": false }, "RegistrationEmailNotSentEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RegistrationEmailNotSent" ] }, "statusCode": { "type": "number", "enum": [ 502 ] }, "code": { "type": "string", "enum": [ "registration_email_not_sent" ] }, "message": { "type": "string" } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "RegistrationEmailTakenEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RegistrationEmailTaken" ] }, "statusCode": { "type": "number", "enum": [ 409 ] }, "code": { "type": "string", "enum": [ "registration_email_taken" ] }, "message": { "type": "string", "enum": [ "An account with this email already exists: sign in at the website and create an API key there" ] } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false }, "RegistrationNotStartedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RegistrationNotStarted" ] }, "statusCode": { "type": "number", "enum": [ 502 ] }, "code": { "type": "string", "enum": [ "registration_not_started" ] }, "message": { "type": "string" } }, "required": [ "_tag", "statusCode", "code", "message" ], "additionalProperties": false } }, "securitySchemes": { "bearer": { "description": "Send `Authorization: Bearer `. The token is an API key, which starts with `bav_` and comes from creating an API key or starting a registration, or the access token of a Bavlio sign-in.", "type": "http", "scheme": "Bearer" } } }, "security": [], "tags": [ { "name": "Registration", "description": "Open a Bavlio account without signing in. Starting a registration returns an API key for a new ephemeral account, which becomes permanent once its email address is verified." }, { "name": "Authentication", "description": "Identify the calling account, finish a registration and manage the account's API keys." }, { "name": "Account", "description": "The account behind your sign-in, and deleting it." }, { "name": "Workspaces", "description": "A workspace holds the company profile, outreach schedule, team, campaigns and billing Bavlio works with. Calls that act in a workspace use the one whose id is in the bavlio-workspace header, or the account's default workspace when the header is absent." }, { "name": "Teams", "description": "Manage who belongs to a workspace: its members, their roles and the invitations to join it. Each workspace's plan sets how many team seats it has." }, { "name": "Campaigns", "description": "A campaign finds leads that match an ideal customer profile (ICP) and buying signals, and reaches out to them through its sequence of LinkedIn and email steps." }, { "name": "Lead imports", "description": "Bring your own leads: preview a CSV, confirm which column holds what, then import it into a campaign, where the leads go through the same sequence as the ones Bavlio finds." }, { "name": "Sequences", "description": "A campaign's sequence is the steps Bavlio runs for each lead: profile visits, likes, invites, LinkedIn messages, emails, waits and conditions. Every message and email waits in the review queue for approval before it is sent." }, { "name": "Inbox", "description": "Conversations with the people your campaigns reached and, for accounts that opt in, your other LinkedIn and email conversations: read them, reply to them and follow changes live." }, { "name": "Reviews", "description": "Messages and emails go to a lead only after someone approves them. The review queue holds the replies Bavlio drafted for people who answered and the messages and emails it drafted for campaign sequences." }, { "name": "Billing", "description": "The plans on offer and the workspace's subscription and usage. Plan changes, cancellation and the billing portal need the workspace owner or an admin." }, { "name": "LinkedIn", "description": "Connect the LinkedIn accounts your campaigns send from, confirm their sign-ins, choose the country LinkedIn sees them from, and disconnect them." }, { "name": "Meetings", "description": "Meetings booked through the workspace's calendar tool (Google Calendar, Calendly or Cal.com), and the calendar connection that imports them." }, { "name": "Email", "description": "Connect a Bavimail account, add sending domains and tracking domains, and create the inboxes campaigns send email from." } ], "servers": [ { "url": "https://api.bavlio.com" } ] } ```