---
# System prepended metadata

title: I.B.S. DASHBOARD (V2-EN)

---

# **GLOSSARY**
Before beginning, some concepts will be defined, according to the use given to it in this application, for better understanding.
- **Signature:** Signatory entity of the certification of evidence with its own digital identity. It has no functions of its own. A client selects with which signature/s to certify the evidence. Note that it is allowed to sign a certification with more than one signature.
- **Evidence:** Set of files to certify by the defined set of signatures.
- **Certification or Certified Evidence:** Unalterable record in blockchain of the content provided.
- **Access token:** Code that allows unique identification to perform actions in the API.
- **Webhook:** Communication of events via HTTP

# **WEB MAP**
## **BEFORE LOGIN**
### **LOGIN**
![](https://hackmd.io/_uploads/B1RnpZVYh.png)

Access page to our application.

It is necessary to be registered in our system to gain access (if you are not yet a customer, go to the [REGISTER](#register) section.

You must enter the email with which the registration was made and the access password (if you have forgotten or lost the password, follow the steps described in the section [DID YOU FORGET THE PASSWORD?](#password)

After entering the data and pressing the "log in" button, the system will verify your credentials and give you access to our functionalities.

### **DID YOU FORGET THE PASSWORD?**<span id="password"><span>
![](https://hackmd.io/_uploads/BJS9gGEYh.png)

If for any reason you have forgotten or lost your access password, our system allows you, with total security, to create a new one to access without problems.
    
To do this, you must follow the following steps:
- On the login page, more or less the center of the main panel, you will find a link to "Did you forget your password?".
- Clicking on this link will open a new panel in which you must enter the same email with which you registered and click send.
- In your email you will receive a message with the instructions to reset your password.
- Click on the "Reset" button in the message and you will be redirected to the new password creation panel.
- Enter the new password, confirm it and press the "send" button.
- The update of the new password will be confirmed and you will be able to log in with it without problem.
    
If you have any problem during the process or you no longer have access to the email with which you register, please contact our <a href="mailto:development@icommunity.io">technical service</a> who, after verifying your identity and ownership of the account, will help you resolve any access issues.
    
### **REGISTER**<span id="register"><span>
![](https://hackmd.io/_uploads/SkSLxf4Yn.png)

Our registration system is quite simple. It's just a matter of filling out a form with your data and sending it to us.
    
The fields to fill in would be:
- **Name or Business Name:** Enter here the name or business name of your natural or legal person.
- **Email:** In this field you must enter the email with which you wish to register. Please note that you will be prompted to verify ownership of the email for security reasons, so it must be a valid email that you own that you can access. You should also take into account that this will be your unique username to connect to the system, therefore, there cannot be two accounts registered with the same email.
- **Password:** Enter the access password you want and confirm it. Remember that the password is your responsibility. The password is solely your property, please do not give it away or share it with third parties. Our company does not have access to this password in a any useful way and therefore is not responsible for any fraudulent use caused by its loss or theft.
- **Registration Code:** At this point you must enter the registration code you received. In case of coming from third-party platforms or marketplaces, the code will have been delivered to the purchase of the product. In case of coming through referrals, they will have given you the registration code. If you don't have a code and want to register, please contact our <a href="mailto:hello@icommunity.io">customer service</a> to get one.
- **Acceptance of "Terms and Conditions" and "Privacy and Data Protection Policy":** At this point you must accept all our legal terms. You have the possibility of reading the complete texts, before accepting them, accessing from the same registration page.
    
Once you have filled out the form and clicked on the "Register" button, you will be able to access our platform directly with the email and password you used to register.
    
At the same time, an email will be sent to your account to confirm it and to indicate, in a more private way, the billing information.

## **AFTER LOGIN**<span id="V2"><span>
### **TOP BAR**
#### **LANGUAGE SELECTOR**
This dropdown will allow you to change the language of our content between English and Spanish.
    
#### **CUSTOMER**
##### **MY PROFILE**
![](https://hackmd.io/_uploads/S1IJbM4F3.png)

This section contains the customer data along with their billing data.
    
All the data can be modified by the client, if necessary.
    
In the customer data section, you will find a link that will open the password modification panel. To do this, you must enter the current password, to demonstrate that it is you who changes it and not anyone who may have had access to your opened session, and create and confirm the new password you want.
    
##### **CONTACT**
![](https://hackmd.io/_uploads/BknlbzVt2.png)

In this section you will find all our forms of contact and social networks.
    
Our contents  are very interesting, we encourage you to check it out.
    
##### **SIGN OFF**
If you select this action, the current session with the client that has been started will be closed.
    
#### **USER MANUAL**
Direct access to this same manual.
    
#### **FULL SCREEN**
This action button will allow you to view our content in full screen, to exit full screen press it again.
    
### **SIDE MENU**
#### **SUMMARY**
![](https://hackmd.io/_uploads/SJifbfEY3.png)

Welcome panel to our dashboard. In it, you can access in summary the most relevant information for the client of our I.B.S. platform.

First of all, you can find four shortcuts to the functions most commonly used by our customers.
- **Signatures:** access to the list of available signatures.
- **New evidence:** access to the panel to make a new evidence.
- **Evidence:** access to the list of evidence carried out.
- **Access tokens:** access to the management panel and generation of access tokens to the API

Secondly, we find an information panel that reflects the consumption made. This panel, in turn, is divided into three sections.
- **This month:** here we can find, graphically, the evidence and signatures made in the current month. If the type of subscription to which the client belongs includes monthly limits, these will also be reflected in this section.
- **From your subscription:** here we can find, graphically, the evidence and signatures made since the beginning of the subscription. If the type of subscription to which the client belongs includes total limits for the duration of the subscription, these will also be reflected in this section. Auto-renewable subscriptions will reset this panel and its limits at the time of renewal.
- **Consumption:** Here we can find, numerically, the consumption made.
     - First of all, we will find the remaining days until the end of the subscription. If this is infinite, the number will be 0 in green. In all other cases, the number will be a countdown marker, which will change color as the end of the subscription approaches: green if there are more than 30 days left, orange if there are between 30 and 15 days left and red if there are less of 15 days.
     - Secondly, we will find the value of evidence consumed during the current month. Depending on the type of subscription, this information may be displayed in three different ways:
         - **Prepaid subscription (closed):** the amount of evidence that remains to be done during the current month period will be displayed. Once this counter reaches zero, no further evidence can be performed until it is reset.
         - **Prepaid-postpaid subscription (open):** Initially, a descending counter will be displayed with the amount of prepaid evidences that remain to be done. Once this counter reaches zero, the counter will become ascending counting the evidence that will be billed at the end of the month for having exceeded the prepaid limit. The lower informative label will indicate the state of the counter.
         - **Postpaid subscription (unlimited):** an ascending counter will be displayed counting the evidence that will be billed at the end of the month.
     - Finally we will find the value of signatures consumed during the current month. Depending on the type of subscription, this information, as in the evidence, may be displayed in three different ways:
         - **Prepaid subscription (closed):** the number of signatures that remain to be created during the current month period will be displayed. Once this counter reaches zero, no more signatures can be created until it is reset.
         - **Prepaid-postpaid subscription (open):** Initially, a descending counter will be displayed with the number of prepaid signatures that remain to be created. Once this counter reaches zero, the counter will become ascending counting the signatures that will be billed at the end of the month for having exceeded the prepaid limit. The lower informative label will indicate the status of the counter.
         - **Postpaid subscription (unlimited):** an ascending counter will be displayed counting the signatures that will be billed at the end of the month.

Finally we will find the sections of last created signatures and last created evidences, where you will be able to see the summarized information of the last 5 signatures and the last 5 evidences of the client. For more information, go to the complete lists of signatures or evidence.

#### **SIGNATURES**
##### **NEW SIGNATURE**
![](https://hackmd.io/_uploads/S184ZM4Y2.png)


From this panel we can start the creation of a new signature.
    
Just by entering a personal identifier (not modifiable) for the signature you want to create and clicking the button, you will be redirected to the iCommunity identity verification system.
    
In it you must follow the instructions to create the digital identity for the signature (For more information see the [digital identity](https://hackmd.io/@iCommunity/SkNBLIFY3) section).
    
Once the process is finished, the signature will remain in a pending state until the data entered is validated. Once approved, the signature will be ready to be used in evidences. 

##### **LISTADO DE FIRMAS**
![](https://hackmd.io/_uploads/SJjHZfVth.png)

List of all signatures created by the client.
    
You will be able to search the list according to the identifying name assigned to the firm when it was created.
    
The status of each signature will be shown in the list, these states being the following:
- **Waiting for documents:** The signature has been created but the necessary documents to carry out the verification process have not yet been uploaded. The button to relaunch the document upload system will appear next to the status.
- **Pending verification:** The verification process is in progress. Our automatic system is checking that all the requirements to verify identity are met.
- **Denied:** The identity verification has been denied for not meeting the requirements. You must re-upload the necessary documents to open a new identity verification process. The button to relaunch the document upload system will appear next to the status.
- **Registration completed:** The identity assigned to the signature has been confirmed and, therefore, this signature can now be used to certify evidence.
    
At the end of the list you will find two action buttons on the signature in question.
- **Evidence:** It will only appear next to the signatures with the status "registration completed" and will redirect to a panel where we can find the list of certified evidence with that signature.
- **Delete:** It will eliminate the signature from this list and from the list for the certification of new evidence. This deletion will not be physical or cascading, since the evidence already certified with that signature will continue to be accessible and the digital identity belonging to this signature will continue to exist in order to verify said evidence certification if necessary. If a deleted signature needs to be reactivated, please contact our <a href="mailto:development@icommunity.io">technical service</a>.

#### **EVIDENCE**
##### **NEW EVIDENCE**
![](https://hackmd.io/_uploads/BJ6wbz4th.png)

From this panel we can create evidence to be certified.
    
The fields to fill in would be the following:
- **Title:** Identifying name of the evidence. It allows the introduction of letters, numbers and symbols with a minimum length of 4 characters and a maximum of 128.
- **Signatures:** Selector from the list of already approved signatures. Our system allows evidence to be certified by more than one signatory.
- **Files:** upload panel for the files to certify. There is no limit to the number of files to certify, but there is a limit to their total size. This limit is 16MB. It must be taken into account that when verifying certified evidence, all the original files must be verified, if only one does not match, the verification would be negative.

Next to the form we will be able to observe the digital footprint of the content, which is a representation of the encoding of the files that will be registered in the blockchain.

It should be remembered that blockchain is not a cloud storage system or anything similar. The certification in blockchain supposes the saving of a system of verification of the non-alteration of the introduced file. Therefore, to carry out the verification it will be necessary to keep the original files.

##### **LIST OF EVIDENCES**
![](https://hackmd.io/_uploads/SkijkqSY3.png)

List of all the evidences created by the client.
    
You will be able to search the list according to the title assigned to the evidence when it was created and the name of one of the signatories.
    
The fields that you can find in the list are the following:
- **Date:** Date and time of the creation of the evidence. Not to be confused with the timestamp in blockchain. In a documentary simile, this date is the date of entry of a request for a procedure and the timestamp is the date of registration in the corresponding volume after the necessary procedures.
- **ID:** Unique identifier of the evidence for the treaty of this if the API is used directly.
- **Title:** Evidence identifier proposed by the client when making the evidence. Note that this field does not have to be unique.
- **Signature:** Signatory/s of the evidence. Is/are the identifier(s) of the digital identity(ies) that the evidence certifies.
- **State:** State in which each piece of evidence is located, these states being the following:
     - **Received:** The evidence has been received by our API and is in the queue for certification
     - **Sent:** The evidence has begun its certification and registration process on the blockchain.
     - **Certificate:** The certification of the evidence has been successfully registered in the blockchain. From this moment this certification is unalterable.
     - **Failed:** The certification of the evidence could not be registered in the blockchain. This status should not appear in your list at any time, as our service is in charge of relaunching a certification in which a problem may have occurred, thus making sure that all evidence is certified and registered correctly. But, as is logical, nothing is 100% infallible and for this reason this status has been taken into account. If it does appear on your list, feel free to contact our <a href="mailto:development@icommunity.io">technical service</a> so we can review and fix the issue.
- **Verify:** Direct link to the corresponding certification in our evidence verifier, where you can see the data recorded in the blockchain, check the integrity of the certified files and check the signer's digital identity.

#### **TOOLS**
![](https://hackmd.io/_uploads/Sk7YWf4Yh.png)
    
Panel with access links to external tools belonging to our ecosystem.
    
Currently only our evidence checker is accessible. New tools will be added in the future.
    
#### **API**
##### **ACCESS TOKENS**
![](https://hackmd.io/_uploads/SyEcWM4K2.png)

Panel for the creation and management of customer access tokens for direct use of the API.
    
First of all, you will find the token creation form. It is only necessary to enter a description or identifier for the requested token and select the duration of validity that is desired for that token.
    
Once this is done, the system will generate an access token based on a random key algorithm that will show you on the screen.
    
**Warning:** Keep in mind that this access token will only be available at this time, once you close the message in which it is delivered to you, the token will no longer be accessible and we will not be able to show it to you again. This is done to ensure that you and only you have access to the token so that no one else (including us) can interact with the API on your behalf. If you don't copy the token at that time or misplace it, you would have no choice but to revoke it and create a new one.
    
After the form, we can find the list of access tokens created by the client. In this list you will find the following fields:
- **Description:** Identifier assigned to the token by the client when creating it. it doesn't have to be unique.
- **Created on:** Token creation date from which its validity begins.
- **Expiration:** Final date of validity of the token. If you have chosen to create a token without an expiration date, the word "never" will appear.
- **Actions:** delete button to be able to revoke a token. This action will render the token invalid (if it has not yet expired) and will remove it from the list.
    
##### **EVENTS**
![](https://hackmd.io/_uploads/ryHjWfVFh.png)

In this panel you will find a list of the events generated by the interaction with the API.
    
In addition to seeing the content of each notification generated by the event, you will be able to forward that information through the registered webhooks simply by selecting the required event and pressing the forward button. The information panel that will appear when forwarding will show the reception or not for each of the webhooks assigned to the type of event.
    
The event information formats will be the same as those we will see below in the webhooks section.
    
##### **WEBHOOKS**
![](https://hackmd.io/_uploads/BJmnbGEK3.png)

Panel for creating and managing webhooks.
    
At the top we can see the creation form. The data to enter would be:
- **Name:** Custom identifier to recognize the webhook.
- **Url:** HTTP address where you want to receive the information. Only valid web address formats will be accepted.
- **Authorization (Optional):** Here you can enter the authorization token for the address entered, if it is restricted access. Otherwise, leave blank.
- **Events to communicate:** There are three types of event to communicate via webhook. You can choose which event/s you want to receive at each address you register. The events in question are:
     - **Certified evidence:** It will be sent to confirm that evidence has been successfully registered on the blockchain. The information sent will have the structure of the following example:
    <pre>
    {
      "id": "evt_nG8rskFSBbc4er2D4TUqre",
      "data": {
        "title": "Cliente 02 - V2 Evidencia 5 (2023-07-03T11:37:57)",
        "network": "matic",
        "payload": {
          "title": "Cliente 02 - V2 Evidencia 5 (2023-07-03T11:37:57)",
          "integrity": [
            {
              "name": "AdamBack.jpg",
              "type": "file",
              "checksum": "WnN4JBhPIeBn7Jrb8bjBUxmxYEgS78vvcyxIlRkiv0cE78qCypfE3uEMguNlcxj9UMFzUv/HbbWXGryXX0i3IQ==",
              "algorithm": "SHA-512",
              "sanitizer": "base64.standard"
            }
          ]
        },
        "evidence_id": "evd_o2UpbTPjBmhDorAFctLc6g",
        "certification_hash": "0x1cda0fc767474b52604be034716f7f2b2b4aedc6eda812d50b78e127ba8ff7e9",
        "certification_timestamp": "2023-07-03T11:39:23Z"
      },
      "event": "evidence.certified"
    }
    </pre>
    - **Identity verification confirmed:** It will be sent after successfully passing the identity verification. It will suppose the passage of a created signature to the valid state for its use in the evidence. The information sent will have the structure of the following example:
    <pre>
    {
      "id": "evt_CWTXw9T3uvHPdYiMBcTotr",
      "data": {
        "signature_id": "sig_SqC2sopk4QGS5VFrrdM4nV"
      },
      "event": "signature.verification.success"
    }
    </pre>
    - **Identity Verification Failed:** Will be sent if the identity verification finds that the identity cannot be approved for some reason. The information sent will have the structure of the following example:
    <pre>
    {
      "id": "evt_Egrgn3SpDRU9q8kbVnLw2X",
      "data": {
        "description": {
          "code":1
          "type":"No Documents"
          "comment": "it's a test"
        },
        "signature_id": "sig_dvkgDzL6BrSdCjTL9X8u27"
      },
      "event": "signature.verification.failed"
    }
    </pre>
##### **DOCUMENTATION**
![](https://hackmd.io/_uploads/SJ4T-z4t3.png)

Panel with links to API documentation, such as:
- **Swagger:** Technical documentation of the API with the possibility of interaction. Shows all call and answer formats.
- **Redoc:** Technical documentation of the API with all the definitions and code examples to make the calls.
- **Youtube video tutorials:** learn how to use our API in a visual and closer way with our video tutorials.
