--- updatedAt: 2026-06-15T22:56:59.000Z agentTools: projectIndex: https://docs.pelcro.com/llms.txt --- # Register Create a customer account and receive an authentication token. ## Overview Create a customer account and return a JWT that authenticates them on protected endpoints. At minimum, provide an `email` and a `password`. **Example:** A visitor signs up on your site. Register them with their email and a password to create their account and immediately receive an authentication token to use for their session. *** ## Conditional Requirements | Condition | Required Fields | | ------------------------------------------------ | --------------------------------------------------------------------------- | | Always | `email`, `password` | | Strong password enforcement is enabled (default) | `password` must meet the complexity rules described on the `password` field | | The site has risk assessment enabled | `security_token` (anti-fraud challenge) | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Open API", "version": "1.88" }, "servers": [ { "url": "https://www.pelcro.com/api/v1/sdk/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "query", "name": "site_id" } } }, "security": [ { "sec0": [] } ], "paths": { "/auth/register": { "post": { "summary": "Register", "description": "Create a customer account and receive an authentication token.", "operationId": "api-open-register", "parameters": [ { "name": "site_id", "in": "query", "description": "The unique identifier of the site associated with your account.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "description": "The customer’s email address. Must have a valid syntax as per RFC 822 standard and be unique under the same account.", "maxLength": 255 }, "password": { "type": "string", "description": "The customer’s password. Must contain at least 6 characters by default, and when [Strong Password Enforcement](https://docs.pelcro.com/docs/security-overview#strong-password-enforcement) security setting is enabled, it must contain between 8 and 30 characters, include at least one number, one symbol, one lowercase, and one uppercase alphabetic character.", "minLength": 6 }, "language": { "type": "string", "description": "The customer’s preferred language as a two-letter code, defined by ISO 639-1 standard. If not specified, it will be set from Accept-Language header, or from the default language defined in your site settings as a fallback.", "default": "en", "enum": [ "en", "fr", "it", "ko", "es" ], "maxLength": 2 }, "username": { "type": "string", "description": "The customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account.", "maxLength": 100, "pattern": "^[A-Za-z0-9_-]+$" }, "display_name": { "type": "string", "description": "A display name that can be used by the customer, the primary use case of this is for commenting systems.", "maxLength": 100 }, "email_hardbounce": { "type": "boolean", "description": "A boolean on whether the customer's email is hardbounce." }, "first_name": { "type": "string", "description": "The customer’s first name." }, "last_name": { "type": "string", "description": "The customer’s last name." }, "metadata": { "type": "array", "description": "Set of key-value pairs that can be saved on customer level. This can be useful for storing additional information about the object in a structured format.", "items": { "properties": { "metadata_key": { "type": "string" } }, "type": "object" } }, "old_provider_id": { "type": "string", "description": "The ID of customer before migrating into Pelcro, this field will be searchable from the platform." }, "organization": { "type": "string", "description": "The customer's organization.", "maxLength": 255 }, "phone": { "type": "string", "description": "The customer phone number. Any string is accepted, which will be stripped of any non-numeric characters." }, "salutation": { "type": "string", "description": "The customer's salutation.", "maxLength": 255 }, "title": { "type": "string", "description": "The customer's title.", "maxLength": 255 }, "name": { "type": [ "string", "null" ], "description": "The customer’s full name." } } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "id": 1017, "name": "Jane Doe", "full_name": "Jane Doe", "first_name": "Jane", "last_name": "Doe", "display_name": null, "username": null, "email": "jane.doe@example.com", "organization": null, "phone": null, "language": "en", "balance": 0, "email_confirm": false, "email_hardbounce": false, "phone_confirm": false, "tin": null, "salutation": null, "title": null, "profile_photo": null, "currency": null, "subscriptions": null, "memberships": null, "expired_memberships": null, "gift_recipients": null, "expired_subscriptions": null, "addresses": null, "invoices": null, "charges": null, "orders": null, "source": null, "sources": [], "metadata": { "key1": "value_for_metadata_key1" }, "is_created": false, "last_login_method": null, "last_active_at": null, "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzODIzNTI1In0.s1gn4tur3", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzODIzNTI1In0.s1gn4tur3" }, "status": "success" } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 1024 }, "name": { "type": "string", "example": "Estel Robel" }, "full_name": { "type": "string", "example": "Estel Robel" }, "first_name": { "type": "string", "example": "Estel" }, "last_name": { "type": "string", "example": "Robel" }, "display_name": { "type": "string", "example": "Estel Robel" }, "username": { "type": "string", "example": "Estel" }, "email": { "type": "string", "example": "Hunter.Pagac17@example.net" }, "organization": { "type": "object", "properties": {} }, "phone": {}, "language": { "type": "string", "example": "en" }, "balance": { "type": "integer", "example": 0 }, "email_confirm": { "type": "boolean", "example": false }, "email_hardbounce": { "type": "boolean", "example": false }, "phone_confirm": { "type": "boolean", "example": false }, "tin": {}, "salutation": { "type": "string", "example": "They/them" }, "title": { "type": "string", "example": "Dr." }, "profile_photo": {}, "currency": {}, "subscriptions": {}, "memberships": {}, "expired_memberships": { "type": "array", "nullable": true, "items": { "type": "object" } }, "gift_recipients": {}, "expired_subscriptions": {}, "addresses": {}, "invoices": {}, "charges": {}, "orders": {}, "source": {}, "sources": { "type": "array" }, "metadata": { "type": "object", "properties": {} }, "is_created": { "type": "boolean", "example": false }, "last_login_method": {}, "last_active_at": { "type": "integer", "nullable": true }, "auth_token": { "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3BlbGNyby1mdHJ1ZGVhdS5uZ3Jvay5pby9hcGkvdjEvc2RrL2F1dGgvcmVnaXN0ZXIiLCJpYXQiOjE2OTgzNTE3ODUsImV4cCI6MTcwMzUzNTc4NSwibmJmIjoxNjk4MzUxNzg1LCJqdGkiOiI2WkZ4WTZ4ZjVSdzk5TEk3Iiwic3ViIjoiMjE4IiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.nSSXLzyBGlowPOitZXgKDBzDGZWNdh9nue8bzVQrkME" }, "token": { "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3BlbGNyby1mdHJ1ZGVhdS5uZ3Jvay5pby9hcGkvdjEvc2RrL2F1dGgvcmVnaXN0ZXIiLCJpYXQiOjE2OTgzNTE3ODUsImV4cCI6MTcwMzUzNTc4NSwibmJmIjoxNjk4MzUxNzg1LCJqdGkiOiI2WkZ4WTZ4ZjVSdzk5TEk3Iiwic3ViIjoiMjE4IiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.nSSXLzyBGlowPOitZXgKDBzDGZWNdh9nue8bzVQrkME" } } }, "status": { "type": "string", "example": "success" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "examples": { "Result": { "value": { "errors": { "email": [ "Please enter your email address" ] } } } }, "schema": { "type": "object", "properties": {} } } } }, "404": { "description": "Not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "report_id": { "type": [ "string", "null" ] }, "status": { "type": "integer" }, "message": { "type": "string" } } } } }, "examples": { "Result": { "value": { "error": { "report_id": null, "status": 404, "message": "You can't use email,password as part of request URL" } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` # Sibling pages * [Login](https://docs.pelcro.com/reference/api-open-login.md) * [Log out](https://docs.pelcro.com/reference/api-open-logout.md) * [Social login](https://docs.pelcro.com/reference/api-open-social-login.md) * [Passwordless](https://docs.pelcro.com/reference/passwordless.md)