Register new user

POST/api/v1/{app_id}/auth/signup

Path parameters

app_idstringrequired

UUID of the app

Request body

requiredapplication/json

User registration details

allow_email_notificationsboolean

allow_phone_notificationsboolean

allow_postal_notificationsboolean

citystring

countrystring

country_codestring

emailstringrequired

first_namestring

languagestring

should be either "en" or "en-gb"

last_namestring

marketstring

passwordstringrequired

min length 8

phone_numberstring

postal_codestring

social_security_numberstring

statusstring

Allowed:activepending

store_groupstring

streetstring

third_party_sign_upboolean

Responses

200

additionsobject | null

addressAddressResponse

Show properties

citystring

countrystring

country_codestring

streetstring

zip_codestring

address_restrictionsOrganisationAddressRestrictionResponse[]

Show properties

Array of OrganisationAddressRestrictionResponse

addressIDstring

formattedAddressstring

organisationIDstring

organisationNamestring

organisationNumberstring

app_idstring

attributesAttributeResponse[] | null

Show properties

Array of AttributeResponse

descriptionstring

idstring

keystring

namestring

template_keystring

translationsAttributeTranslationsResponse

Show properties

descriptionobject

nameobject

valuesobject

commentstring

communication_preferencesCommunicationPreferencesResponse

Show properties

allow_emailboolean

allow_postalboolean

allow_smsboolean

created_atstring

customer_groupsCustomerGroupRefResponse[] | null

Show properties

Array of CustomerGroupRefResponse

idstring

namestring

slugstring

emailstring

email_verifiedboolean

filesFileResponse[] | null

Show properties

Array of FileResponse

app_idstring

content_typestring

created_atstring

custom_fieldsobject

filenamestring

idstring

updated_atstring

urlstring

first_namestring

idstring

is_super_adminboolean

languagestring

last_login_atstring

last_namestring

marketstring

market_currencystring

market_idstring | null

organisationsOrganisationWithUserRelationResponse[] | null

Show properties

Array of OrganisationWithUserRelationResponse

app_idstring

attributesAttributeResponse[] | null

Show properties

Array of AttributeResponse

descriptionstring

idstring

keystring

namestring

template_keystring

translationsAttributeTranslationsResponse

valuesobject

billing_addressCompanyAddressResponse[] | null

Show properties

Array of CompanyAddressResponse

citystring

co_addressstring

company_idstring

company_namestring

countrystring

created_atstring

house_numberstring

idstring

is_defaultboolean

namestring

phonestring

postal_codestring

shipping_typestring

state_provincestring

street_addressstring

updated_atstring

commentstring

contact_namestring

created_atstring

credit_checkboolean

custom_fieldsobject

custom_role_idstring | null

customer_groupsCustomerGroupRefResponse[] | null

Show properties

Array of CustomerGroupRefResponse

idstring

namestring

slugstring

emailstring

external_refstring

filesFileResponse[] | null

Show properties

Array of FileResponse

app_idstring

content_typestring

created_atstring

custom_fieldsobject

filenamestring

idstring

updated_atstring

urlstring

idstring

invoice_emailstring

levelstring | null

namestring

organisation_numberstring | null

parent_idstring | null

phonestring

rolestring | null

role_namestring | null

shipping_addressCompanyAddressResponse[] | null

Show properties

Array of CompanyAddressResponse

citystring

co_addressstring

company_idstring

company_namestring

countrystring

created_atstring

house_numberstring

idstring

is_defaultboolean

namestring

phonestring

postal_codestring

shipping_typestring

state_provincestring

street_addressstring

updated_atstring

statusstring

store_groupsStoreGroupResponse[] | null

Show properties

Array of StoreGroupResponse

country_of_salestring | null

created_atstring

descriptionstring | null

idstring

namestring

slugstring

store_typestring

updated_atstring | null

tagsTagResponse[] | null

Show properties

Array of TagResponse

app_idstring

idstring

keystring

namestring

tax_id_vat_numberstring

updated_atstring

phone_numberstring

social_security_numberstring

statusstring

store_groupstring

store_group_idstring | null

tagsTagResponse[]

Show properties

Array of TagResponse

app_idstring

idstring

keystring

namestring

third_party_sign_upboolean

updated_atstring

400

Invalid request

detailsstring[] | null

messagestring

successboolean

404

App not found

detailsstring[] | null

messagestring

successboolean

500

Internal server error

detailsstring[] | null

messagestring

successboolean

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

app_idpath*UUID of the app

Bodyapplication/json

allow_email_notificationsbooleanallow_phone_notificationsbooleanallow_postal_notificationsbooleancitystringcountrystringcountry_codestringemailstring*first_namestringlanguagestringshould be either "en" or "en-gb"last_namestringmarketstringpasswordstring*phone_numberstringpostal_codestringsocial_security_numberstringstatusstringstore_groupstringstreetstringthird_party_sign_upboolean

Request

curl -X POST '//customers.enad.io/api/v1/string/auth/signup' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "allow_email_notifications": true,
  "allow_phone_notifications": true,
  "allow_postal_notifications": true,
  "city": "string",
  "country": "string",
  "country_code": "string",
  "email": "string",
  "first_name": "string",
  "language": "string",
  "last_name": "string",
  "market": "string",
  "password": "stringst",
  "phone_number": "string",
  "postal_code": "string",
  "social_security_number": "string",
  "status": "active",
  "store_group": "string",
  "street": "string",
  "third_party_sign_up": true
}'

const response = await fetch("//customers.enad.io/api/v1/string/auth/signup", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"allow_email_notifications\": true,\n  \"allow_phone_notifications\": true,\n  \"allow_postal_notifications\": true,\n  \"city\": \"string\",\n  \"country\": \"string\",\n  \"country_code\": \"string\",\n  \"email\": \"string\",\n  \"first_name\": \"string\",\n  \"language\": \"string\",\n  \"last_name\": \"string\",\n  \"market\": \"string\",\n  \"password\": \"stringst\",\n  \"phone_number\": \"string\",\n  \"postal_code\": \"string\",\n  \"social_security_number\": \"string\",\n  \"status\": \"active\",\n  \"store_group\": \"string\",\n  \"street\": \"string\",\n  \"third_party_sign_up\": true\n}"
});

import requests

response = requests.post(
    "//customers.enad.io/api/v1/string/auth/signup",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"allow_email_notifications\": true,\n  \"allow_phone_notifications\": true,\n  \"allow_postal_notifications\": true,\n  \"city\": \"string\",\n  \"country\": \"string\",\n  \"country_code\": \"string\",\n  \"email\": \"string\",\n  \"first_name\": \"string\",\n  \"language\": \"string\",\n  \"last_name\": \"string\",\n  \"market\": \"string\",\n  \"password\": \"stringst\",\n  \"phone_number\": \"string\",\n  \"postal_code\": \"string\",\n  \"social_security_number\": \"string\",\n  \"status\": \"active\",\n  \"store_group\": \"string\",\n  \"street\": \"string\",\n  \"third_party_sign_up\": true\n}",
)

Response

{
  "additions": {
    "property1": "string",
    "property2": "string"
  },
  "address": {
    "city": "string",
    "country": "string",
    "country_code": "string",
    "street": "string",
    "zip_code": "string"
  },
  "address_restrictions": [
    {
      "addressID": "string",
      "formattedAddress": "string",
      "organisationID": "string",
      "organisationName": "string",
      "organisationNumber": "string"
    }
  ],
  "app_id": "string",
  "attributes": [
    {
      "description": "string",
      "id": "string",
      "key": "string",
      "name": "string",
      "template_key": "string",
      "translations": {
        "description": {
          "property1": "string",
          "property2": "string"
        },
        "name": {
          "property1": "string",
          "property2": "string"
        }
      },
      "values": {
        "property1": [
          {
            "translations": {
              "value": {
                "property1": "string",
                "property2": "string"
              }
            },
            "type": "string",
            "value": "string"
          }
        ],
        "property2": [
          {
            "translations": {
              "value": {
                "property1": "string",
                "property2": "string"
              }
            },
            "type": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "comment": "string",
  "communication_preferences": {
    "allow_email": true,
    "allow_postal": true,
    "allow_sms": true
  },
  "created_at": "string",
  "customer_groups": [
    {
      "id": "string",
      "name": "string",
      "slug": "string"
    }
  ],
  "email": "string",
  "email_verified": true,
  "files": [
    {
      "app_id": "string",
      "content_type": "string",
      "created_at": "string",
      "custom_fields": {
        "property1": null,
        "property2": null
      },
      "filename": "string",
      "id": "string",
      "updated_at": "string",
      "url": "string"
    }
  ],
  "first_name": "string",
  "id": "string",
  "is_super_admin": true,
  "language": "string",
  "last_login_at": "string",
  "last_name": "string",
  "market": "string",
  "market_currency": "string",
  "market_id": "string",
  "organisations": [
    {
      "app_id": "string",
      "attributes": [
        {
          "description": "string",
          "id": "string",
          "key": "string",
          "name": "string",
          "template_key": "string",
          "translations": {
            "description": {
              "property1": "string",
              "property2": "string"
            },
            "name": {
              "property1": "string",
              "property2": "string"
            }
          },
          "values": {
            "property1": [
              {
                "translations": {
                  "value": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "type": "string",
                "value": "string"
              }
            ],
            "property2": [
              {
                "translations": {
                  "value": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "type": "string",
                "value": "string"
              }
            ]
          }
        }
      ],
      "billing_address": [
        {
          "city": "string",
          "co_address": "string",
          "company_id": "string",
          "company_name": "string",
          "country": "string",
          "created_at": "string",
          "house_number": "string",
          "id": "string",
          "is_default": true,
          "name": "string",
          "phone": "string",
          "postal_code": "string",
          "shipping_type": "string",
          "state_province": "string",
          "street_address": "string",
          "updated_at": "string"
        }
      ],
      "comment": "string",
      "contact_name": "string",
      "created_at": "string",
      "credit_check": true,
      "custom_fields": {
        "property1": "string",
        "property2": "string"
      },
      "custom_role_id": "string",
      "customer_groups": [
        {
          "id": "string",
          "name": "string",
          "slug": "string"
        }
      ],
      "email": "string",
      "external_ref": "string",
      "files": [
        {
          "app_id": "string",
          "content_type": "string",
          "created_at": "string",
          "custom_fields": {
            "property1": null,
            "property2": null
          },
          "filename": "string",
          "id": "string",
          "updated_at": "string",
          "url": "string"
        }
      ],
      "id": "string",
      "invoice_email": "string",
      "level": "string",
      "name": "string",
      "organisation_number": "string",
      "parent_id": "string",
      "phone": "string",
      "role": "string",
      "role_name": "string",
      "shipping_address": [
        {
          "city": "string",
          "co_address": "string",
          "company_id": "string",
          "company_name": "string",
          "country": "string",
          "created_at": "string",
          "house_number": "string",
          "id": "string",
          "is_default": true,
          "name": "string",
          "phone": "string",
          "postal_code": "string",
          "shipping_type": "string",
          "state_province": "string",
          "street_address": "string",
          "updated_at": "string"
        }
      ],
      "status": "string",
      "store_groups": [
        {
          "country_of_sale": "string",
          "created_at": "string",
          "description": "string",
          "id": "string",
          "name": "string",
          "slug": "string",
          "store_type": "string",
          "updated_at": "string"
        }
      ],
      "tags": [
        {
          "app_id": "string",
          "id": "string",
          "key": "string",
          "name": "string"
        }
      ],
      "tax_id_vat_number": "string",
      "updated_at": "string"
    }
  ],
  "phone_number": "string",
  "social_security_number": "string",
  "status": "string",
  "store_group": "string",
  "store_group_id": "string",
  "tags": [
    {
      "app_id": "string",
      "id": "string",
      "key": "string",
      "name": "string"
    }
  ],
  "third_party_sign_up": true,
  "updated_at": "string"
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}