Authentication

The authentication process describe how to add a link to your website to Securitize D and how to retrieve the information provided after the login process and use it on Connect API

PreviousAccessing the APIs NextAccess Token

Last updated 3 years ago

Was this helpful?

Authentication

The authentication process describe how to add a link to your website to Securitize D and how to retrieve the information provided after the login process and use it on Connect API

Requisites

Before you can interact with Securitize iD APIs, request from Customer Success team the following information:

issuerID or DomainID: this is the ID which identifies your unique Domain.
OAuthsecret: this is the OAuth secret.
Base URL: where to connect to Securitize iD (Sandbox or Production environments).

You will have to provide a redirectURL to a server where your logic is running. This URL has to be whitelisted by Securite. You can find more information of how to perform the process .

In order to integrate Securitize iD as an authentication procedure, you will just have to add a Log in with Securitize iD button to your log in/registration page. That button will provide a link to initiate the OAuth process so the user can login and carry out the verification steps.

The initial flow

Initiating the OAuth process

To initiate the authentication process simply redirect the user to:

https://id.securitize.io/#/authorize?issuerId=[CLIENT_ID]&scope=[SCOPE]&redirecturl=[REDIRECT_URL]

Parameter

Description

CLIENT_ID

Your application client id provided by Securitize

SCOPE

Scope of data access (we currently only support info details verification)

REDIRECT_URL

The url to redirect after investor signs the data share agreement. MUST be list in redirectUrls array.

Example:

https://id.securitize.io/#/authorize?issuerId=123e4567-e89b&scope=info%20details%20verification&redirecturl=https://dashboard.securitize.io/authorization

<body>
 <div id="SecuritizeID">
 </div>
</body>

function showSecuritizeIDLogInLogo() {
   var baseUrl     = "STRING";
   var issuerID    = "STRING";
   var scope       = "info details verification";
   var redirecturl = "URL"

   var securitizeID = document.getElementById("SecuritizeID");
   var link = document.createElement("a");
   var logo = document.createElement("img");

   var href = baseUrl + "#/authorize" + "?issuerId=" 
              + issuerID + "&scope=" + scope + "&redirecturl=" + redirecturl;
   logo.src = "./images/securitizeID.png";
   link.href = href;
   link.appendChild(logo);
   securitizeID.appendChild(link);
 }

Working with OAuth response

If the process was successful we will return the following data added to your redirect url

https://REDICT_URL?code=40cba031-8fd2-4a88-89ff-36e07e5e060b&country=US&authorized=true

Parameter

Description

code

Authorisation code used to get the user access token. (Code will expire after 5 minutes)

country

Securitize iD Investor country

authorized

Returns true if investor was authorized on with your Application in the past. NOTE: does not return if its the first time investor is going through OAuth process with your application

Example:

This JavaScript snippet captures the query string of the redirected URL:

 function captureTOKEN() {
   const queryString = window.location.search;
   const urlParams   = new URLSearchParams(queryString);
   const code        = urlParams.get("code");
   const country     = urlParams.get("country");
   const authorized  = urlParams.get("authorized");
   console.log(code, country, authorized);
   if (authorized == "true") {
     // User has signed-up and has a SecuritizeID
   }
 }

PreviousAccessing the APIs NextAccess Token

Last updated 3 years ago

Was this helpful?

Requisites

Before you can interact with Securitize iD APIs, request from Customer Success team the following information:

issuerID or DomainID: this is the ID which identifies your unique Domain.
OAuthsecret: this is the OAuth secret.
Base URL: where to connect to Securitize iD (Sandbox or Production environments).

You will have to provide a redirectURL to a server where your logic is running. This URL has to be whitelisted by Securite. You can find more information of how to perform the process .

The initial flow

Initiating the OAuth process

To initiate the authentication process simply redirect the user to:

https://id.securitize.io/#/authorize?issuerId=[CLIENT_ID]&scope=[SCOPE]&redirecturl=[REDIRECT_URL]

Parameter

Description

CLIENT_ID

Your application client id provided by Securitize

SCOPE

Scope of data access (we currently only support info details verification)

REDIRECT_URL

The url to redirect after investor signs the data share agreement. MUST be list in redirectUrls array.

Example:

https://id.securitize.io/#/authorize?issuerId=123e4567-e89b&scope=info%20details%20verification&redirecturl=https://dashboard.securitize.io/authorization

<body>
 <div id="SecuritizeID">
 </div>
</body>

function showSecuritizeIDLogInLogo() {
   var baseUrl     = "STRING";
   var issuerID    = "STRING";
   var scope       = "info details verification";
   var redirecturl = "URL"

   var securitizeID = document.getElementById("SecuritizeID");
   var link = document.createElement("a");
   var logo = document.createElement("img");

   var href = baseUrl + "#/authorize" + "?issuerId=" 
              + issuerID + "&scope=" + scope + "&redirecturl=" + redirecturl;
   logo.src = "./images/securitizeID.png";
   link.href = href;
   link.appendChild(logo);
   securitizeID.appendChild(link);
 }

Working with OAuth response

If the process was successful we will return the following data added to your redirect url

https://REDICT_URL?code=40cba031-8fd2-4a88-89ff-36e07e5e060b&country=US&authorized=true

Parameter

Description

code

Authorisation code used to get the user access token. (Code will expire after 5 minutes)

country

Securitize iD Investor country

authorized

Returns true if investor was authorized on with your Application in the past. NOTE: does not return if its the first time investor is going through OAuth process with your application

Example:

This JavaScript snippet captures the query string of the redirected URL:

 function captureTOKEN() {
   const queryString = window.location.search;
   const urlParams   = new URLSearchParams(queryString);
   const code        = urlParams.get("code");
   const country     = urlParams.get("country");
   const authorized  = urlParams.get("authorized");
   console.log(code, country, authorized);
   if (authorized == "true") {
     // User has signed-up and has a SecuritizeID
   }
 }