Email Provider


POST/v1/{APPID}/email/login

Login User

This API endpoint allows you to log in a user to your application using their email address and password.

Required attributes

  • Name
    email
    Type
    string
    Description

    The user's email address.

  • Name
    password
    Type
    string
    Description

    The user's password.

Request

POST
/v1/{APPID}/email/login
curl https://api.authc1.com/v1/{APPID}/email/login \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "email": "[email protected]",
    "password": "mypassword"
  }'

Response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "user": {
    "id": "123456",
    "email": "[email protected]",
    "name": "John Doe"
  }
}

POST/v1/{APPID}/email/register

Register User

This API endpoint allows you to register a new user to your application using their email address and password.

Required attributes

  • Name
    name
    Type
    string
    Description

    The user's name.

  • Name
    email
    Type
    string
    Description

    The user's email address.

  • Name
    password
    Type
    string
    Description

    The user's password.

Request

POST
/v1/{APPID}/email/register
curl https://api.authc1.com/v1/{APPID}/email/register \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "name": "John Doe",
    "email": "[email protected]",
    "password": "mypassword"
  }'

Response

  {
    "email": "[email protected]",
    "name": "John Doe",
    "local_id": "fcc45e40999d78973c0c5d92623f05da0b283c62876c0dfbed65778bbf41a03b",
    "expires_in": 86400,
    "expires_at": 1683572605
  }

POST/v1/{APPID}/email/verify

Verify Email

This API endpoint allows you to verify an email address registered with AuthC1 using your application.

Empty payload

This endpoint expects an empty payload, please do not include any data in your payload when calling this endpoint.

Request

POST
/v1/{APPID}/email/verify
curl https://api.authc1.com/v1/{APPID}/email/verify \
  -H "Content-Type: application/json" \
  -X POST

Response

{
  "email": "[email protected]"
}

POST/v1/{APPID}/email/confirm

Confirm Email

This API endpoint confirms a user's email address registered with AuthC1 using your application.

Required attributes

  • Name
    code
    Type
    string
    Description

    The confirmation code received by the user via email.

Request

POST
/v1/{APPID}/email/confirm
curl https://api.authc1.com/v1/{APPID}/email/confirm \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "code": "xxxx"
  }'

Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600,
  "expires_at": 1645239717,
  "name": "John Doe",
  "local_id": "123456",
  "email": "[email protected]"
}

POST/v1/{APPID}/email/forgot-password

Forgot Password

This API endpoint allows users to reset their password by sending a password reset email.

Required attributes

  • Name
    email
    Type
    string
    Description

    The user's email address.

Request

POST
/v1/{APPID}/email/forgot-password
curl https://api.authc1.com/v1/{APPID}/email/forgot-password \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "email": "[email protected]"
  }'

Response

{
  "email": "[email protected]"
}

POST/v1/{APPID}/email/confirm-password

Confirm Password

This API endpoint confirms a user's new password after resetting it.

Required attributes

  • Name
    email
    Type
    string
    Description

    The user's email address.

  • Name
    code
    Type
    string
    Description

    The confirmation code received by the user via email.

  • Name
    password
    Type
    string
    Description

    The password being reset.

Request

POST
/v1/{APPID}/email/confirm-password
curl https://api.authc1.com/v1/{APPID}/email/confirm-password \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "email": "[email protected]",
    "code": "xxxx",
    "password": "newPassword"
  }'

Response

{
  "email": "[email protected]"
}