Live Demo

Get started with Circle Access and start securing your application and your user data

On this page

How it works

This live demo contains real examples of an application communicating with Circle Access APIs to authenticate and request 2FA (Two Factor Authentication) for a variety of needs. If you want information about signing the requests or checking the responses signatures, please check our documentation

Company

For this demo, we will use the following fake company:

  • Company Name: Demo Company

Application

Each company can have multiples applications and each application will have its own app key, read/write keys, and login URL. When you create an application on our platform, you will receive the following data

  • Application Name: Demo App
  • App Key: app9KrRWQS9DjtpzNgWcbHNt68S7Y1DfUJJV
  • Read Key: readFk4HtTqLNcTZYZzmHUNfT3jjt1EwqYRu3
  • Write Key: writeNRZpXhseVhV3pk1mrw7rxvEJLa4AXwzzH
  • Login URL: https://circleaccess.circlesecurity.ai/login/app9KrRWQS9DjtpzNgWcbHNt68S7Y1DfUJJV

App Key

The App Key is how you interact and let the API know who you are. Each app has its own App Key.

Read and Write Keys

These keys are used for signing and verifying the requests/responses. The Write Key is used when you send information to the API, so the API is sure that you are making the request. The Read Key is used to verify the information received from the API, so you can be sure that the information was not altered.

Login URL

After informing some information (such as the return URL for the login), the platform will create a specific Login URL for your app.

Authentication

Download Circle Access app for (iOS or Android) to scan the Authentication QRCode.

Demo

Click the button below

Authentication Return

Received URL with params:

Not authenticated yet!

Received URL Query String displayed as JSON:

Not authenticated yet!

2FA

When you already have users, you can create factor authentications with:

  • their userID (from the login) and/or;
  • their email or;
  • their phone number.

Important to mention that you do not need to use userID to use factor authentication. You can use only the user email or phone number, and a question that will have 2 possible answers, Accept or Deny.

Demo

First, we need to call the API to create the factor authentication link (factorUrl):

Question *
Custom ID *
userID **(from the login above)
E-mail
Phone

You need at least one parameter. UserID, email or phone. Check the documentation for all parameters.

* Required field
** Optional 
{
  "status": "Waiting for payload",
}

Authorization API

As the Authorization API is huge, we've created a special whole page section so you can play around with it. Please check Authorization API DEMO or click the button below and see it live.

Authorization API

More information

For more information, please check our documentation. Or head to console to create your apps