Register

post

https://www.pelcro.com/api/v1/sdk/auth/register

Create a customer account and receive an authentication token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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)

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

string

required

length ≤ 255

The customer’s email address. Must have a valid syntax as per RFC 822 standard and be unique under the same account.

password

string

required

length ≥ 6

The customer’s password. Must contain at least 6 characters by default, and when 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.

language

string

enum

length ≤ 2

Defaults to en

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.

Allowed:

username

string

length ≤ 100

The customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account.

display_name

string

length ≤ 100

A display name that can be used by the customer, the primary use case of this is for commenting systems.

email_hardbounce

boolean

A boolean on whether the customer's email is hardbounce.

first_name

string

The customer’s first name.

last_name

string

The customer’s last name.

metadata

array of objects

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.

metadata

old_provider_id

string

The ID of customer before migrating into Pelcro, this field will be searchable from the platform.

organization

string

length ≤ 255

The customer's organization.

phone

string

The customer phone number. Any string is accepted, which will be stripped of any non-numeric characters.

salutation

string

length ≤ 255

The customer's salutation.

title

string

length ≤ 255

The customer's title.

name

string | null

The customer’s full name.

Responses

Overview

Conditional Requirements

200Success.

400Invalid request.

404Not found.