Sign up

This module consists of login, registration, password reset and refresh token. At the moment there are 2 flows - simple and with email confirmation.

In the token settings, you can activate the "Email confirmation" option. This will add an intermediate step during registration and login.

Requests for the intermediate step will be in folders named “Email confirmation

1. Get feature in Postman collection

2. Sign-up

Simple mode

Everything is easy in this step. You need send 2 fields in body of request - email, password and password_confirmation.

💡 In Postman, each endpoint includes some response cases (HTTP: 200,422 …). So you can see result of work using different input client data.

Success case:

{
    "notification": "auth.registration.completed",
    "warning": null,
    "variables": null,
    "internalStatus": "502",
    "response": [],
    "errors": null
}

Custom mode - with email confirmation

If you enable “Email confirmation”, you will get another response (in success case):

{
    "notification": null,
    "warning": null,
    "variables": null,
    "internalStatus": "101",
    "response": {
        "resendCodeLockTime": 60,
        "tempIdLifeTime": 600,
        "tempId": "0e86d0cf-bfc4-4efe-aadd-c04cfb4774b0"
    },
    "errors": null
}

To confirm registration, you need send some code, which system generated. Let’s explain some attributes:

  • tempId - Temporary id of user, which will be use in next step. A temporary registration confirmation code is associated with this key.

  • tempIdLifeTime - Temporary id life time (in seconds). So, this code will be expire after 10 minutes.

  • resendCodeLockTime - How often you can do resend/regenerate confirmation code.

Project doesn’t use email clients. Instead I developed own notification system, which in your account. All confirmation codes and other info, will be showing on this page. Open my notifications

Custom mode - do confirmation

Now, we need to confirm registration with code, which got from page of notifications.

Use this request. Let’s see arguments of body:

  • tempId - string from past response

  • code - 6 digits number from page of notifications

If all are correct, you will be success response:

{
    "notification": "auth.registration.completed",
    "warning": null,
    "variables": null,
    "internalStatus": "502",
    "response": [],
    "errors": null
}

You can also get other answers (see Postman) like:

  • 429 - Too many attempts.

  • 422 - Expired code

  • 422 - Invalid tempId

Last updated

#20:

Change request updated