API GUIDE

3vidence API

Auth

Check Auth health

GET https://api.3vidence.com/auth/health

This endpoint helps to verify all the systems related to auth system are OK.

{
  "db": "Ok",
  "crypto": "Ok",
  "http": "Ok"
}

curl --request GET \
  --url https://api.3vidence.com/auth/health

Verify your account

GET https://api.3vidence.com/auth/verification/YOUR_VERIFICATION_CODE

This endpoint helps you to verify your account.

Path Parameters

Name

Type

Description

YOUR_VERIFICATION_CODE

string

an hexadecimal code, it was sent it to your email.

{
  "message": "Resource updated"
}

curl --request GET \
  --url https://api.3vidence.com/auth/verification/YOUR_VERIFICATION_CODE

POST https://api.3vidence.com/auth/login

Request Body

Name

Type

Description

password

string

Your hex password

string

Your email

{
  "jwt": "eyJhbGciOiJlZGRzYTI1NTE5IiwidHlwIjoiand0In0=.eyJpc3MiOiIzdmlkZW5jZSIsInN1YiI6IjUwNjk3RDY3MUNCQTY2ODg1NzMyRUM0QTgxRjEyQzg5QkY2NzczRUI4OTU0RDFBQTY4NTc3ODZEOEM5MTYyQTciLCJleHAiOjE2MDYyOTA4NDkxNDEsIm5iZiI6MTYwNjI2MjA0OTE0MSwiaWF0IjoxNjA2MjYyMDQ5MTQxLCJqdGkiOiI1MDY5N0Q2NzFDQkE2Njg4NTczMkVDNEE4MUYxMkM4OUJGNjc3M0VCODk1NEQxQUE2ODU3Nzg2RDhDOTE2MkE3LjE2MDYyNjIwNDkxNDEifQ==.QEj74NDFjMGrllw1MTeXHNdeIir1r4Dj9pfGf6RCZGB8PJjpqy2V/GjNfGl28bKzug2R7ga1hS2NVuPrx6BGCQ=="
}

curl --request POST \
  --url https://api.3vidence.com/auth/login \
  --header 'content-type: application/json' \
  --data '{"email": "YOUR_EMAIL",
  "password": "YOUR_PASSWORD"}'

Update your password

PUT https://api.3vidence.com/auth/password

This endpoint helps you to update your login password

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

{
  "email": "YOUR_EMAIL",
  "password": "YOUR_NEW_PASSWORD"
}

curl --request PUT \
  --url https://api.3vidence.com/auth/password \
  --header 'authorization: YOUR_LOGIN_JWT'

HTSP

Check HTSP health

GET https://api.3vidence.com/htsp/health

This endpoint helps you to check htsp status systems are OK

{
  "db": "Ok",
  "crypto": "Ok",
  "http": "Ok"
}

curl --request GET \
  --url https://api.3vidence.com/htsp/health

Create a subject

POST https://api.3vidence.com/htsp/subject

This endpoint helps you to create a subject

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

Request Body

Name

Type

Description

type

string

"email"

subject

string

an email

{
  "subject": "YOUR_EMAIL",
  "id_sec": "YOUR_ID_SEC"
}

curl --request POST \
  --url https://api.3vidence.com/htsp/subject \
  --header 'authorization: YOUR_LOGIN_JWT' \
  --header 'content-type: application/json' \
  --data '{"subject": "YOUR_EMAIL", "type": "email"}'

Verify your subject

GET https://api.3vidence.com/htsp/verification/YOUR_VERIFICATION_CODE

This endpoint helps you to verify a subject

Path Parameters

Name

Type

Description

YOUR_VERIFICATION_CODE

string

It was sent it to your email

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

{
  "message": "Resource updated"
}

curl --request GET \
  --url https://api.3vidence.com/htsp/verification/YOUR_VERIFICATION_CODE \
  --header 'authorization: YOUR_LOGIN_JWT'

Delete a subject

DELETE https://api.3vidence.com/htsp/subject

This endpoint helps you to delete a subject

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

Request Body

Name

Type

Description

id_sec

string

YOUR_ID_SEC (you get it from create subject)

{
  "subject": "Resource deleted"
}

  https://api.3vidence.com/htsp/subject \
  --header 'authorization: YOUR_LOGIN_JWT' \
  --header 'content-type: application/json' \
  --data '{"id_sec":"YOUR_ID_SEC"}'

Create a branch

POST https://api.3vidence.com/htsp/branch

This endpoint helps you to create a branch

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

Request Body

Name

Type

Description

id_sec

string

YOUR_ID_SEC

suite

string

["ed25519+dilithium2","ed25519+rsa"]

branch

string

YOUR_BRANCH_NAME

{
  "api_key": "YOUR_API_KEY"
}

curl --request POST \
  --url https://api.3vidence.com/htsp/branch \
  --header 'authorization: YOUR_LOGIN_JWT'\
  --header 'content-type: application/json' \
  --data '{"id_sec": "YOUR_ID_SEC", "branch":
   "YOUR_BRANCH_NAME", "suite": SUITE}'

Delete a branch

DELETE https://api.3vidence.com/htsp/branch

This endpoint helps you to delete a branch

Path Parameters

Name

Type

Description

kid

string

First 64 characters from your apikey

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

{
  "branch": "Resource deleted"
}

curl --request DELETE \
  --url https://api.3vidence.com/htsp/branch \
  --header 'authorization: YOUR_LOGIN_JWT' \
  --header 'content-type: application/json' \
  --data '{"kid":"YOUR_KID"}'

Update API key password

PUT https://api.3vidence.com/htsp/apikey

This endpoint helps you to update the API key password

Path Parameters

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT (you can get from login endpoint)

Request Body

Name

Type

Description

api_key

string

YOUR_API_KEY (you get it from create branch)

{
  "api_key": "YOUR_API_KEY"
}

curl --request PUT \
  --url https://api.3vidence.com/htsp/apikey \
  --header 'authorization: YOUR_LOGIN_JWT' \
  --header 'content-type: application/json' \
  --data '{"api_key": "YOUR_API_KEY"}'

Public key info

GET https://api.3vidence.com/htsp/pubkey/YOUR_KID

{
  "EdDSA": {
    "algorithm": "ED25519",
    "pubkey": "HEX",
    "error": ""
  },
  "PQ": {
    "algorithm": "DILITHIUM",
    "parameter": "dilithium2",
    "pubkey": "HEX",
    "error": ""
  },
  "suite": "ed25519+dilithium2",
  "timestamp": 1602212289391
}

curl --request GET \
  --url https://api.3vidence.com/htsp/pubkey/YOUR_KID

Sign anonymously

POST https://api.3vidence.com//htsp/open/htsq

Request Body

Name

Type

Description

hash

string

YOUR_HASH

algorithm

string

["sha224","sha3224","sha256","sha3_256","sha384","sha3_384","sha512","sha3_512","whirlpool

curl --request POST \
  --url https://api.3vidence.com//htsp/open/htsq \
  --header 'Content-Type: application/json' \
  --data '{"algorithm":"sha256","hash":"YOUR_HASH"}'

Sign

POST https://api.3vidence.com/htsp/htsq

This endpoint helps you to sign

Request Body

Name

Type

Description

desc

string

description if bool is "true"

cloud

boolean

save your signature on cloud

api_key

string

YOUR_API_KEY (you get it from create branch)

hash

string

YOUR_HASH

algorithm

string

["sha224","sha3224","sha256","sha3_256","sha384","sha3_384","sha512","sha3_512","whirlpool"]

{
  "hjws": "YOUR_HJWS",
  "kid": "YOUR_KID",
  "id_hjws": "YOUR_ID_HJWS"
}

curl --request POST \
  --url https://api.3vidence.com/htsp/htsq \
  --header 'content-type: application/json' \
  --data '{ "api_key": "YOUR_API_KEY",
   "algorithm":"HASH_ALGORITHM","hash":"YOUR_HASH",
    "cloud": BOOL, "desc": "YOUR_DESCRIPTION"}'

Verify

GET https://api.3vidence.com/htsp/htsr

This endpoint helps you to verify a signature

Request Body

Name

Type

Description

kid

string

YOUR_KID (you get it from sign)

hjws

string

YOUR_HJWS (you get it from sign)

{
  "iss": "3vidence Corp",
  "sub": "YOUR_SUBJECT",
  "brn": "YOUR_BRANCH",
  "iat": "Timestamp",
  "hash": "HASH",
  "alg": "HASH_ALGORITHM",
  "kid": "YOUR_KID",
  "suite": "SUITE"
}

curl --request POST \
  --url https://api.3vidence.com/htsp/htsr \
  --header 'content-type: application/json' \
  --data '{"hjws": "YOUR_HJWS",
  "kid": "YOUR_KID"}'

Upload HJWS

POST https://api.3vidence.com/htsp/hjws

Request Body

Name

Type

Description

api_key

string

YOUR_API_KEY

kid

string

YOUR_KID

hjws

string

YOUR_HJWS

{
  "id_hjws": "YOUR_ID_HJWS"
}

curl --request POST \
  --url https://api.3vidence.com/htsp/hjws \
  --header 'content-type: application/json' \
  --data '{ "hjws": "YOUR_HJWS",
  "kid": "YOUR_KID"
  ,"api_key": "YOUR_API_KEY"}'

Get a hjws

Read HWJS

GET https://api.3vidence.com/htsp/hjws/YOUR_ID_HJWS

{
  "iss": "3vidence Corp",
  "sub": "YOUR_SUBJECT",
  "brn": "YOUR_BRANCH",
  "iat": "Timestamp",
  "hash": "HASH",
  "alg": "HASH_ALGORITHM",
  "kid": "YOUR_KID",
  "suite": "SUITE"
}

curl --request GET \
  --url https://api.3vidence.com/htsp/hjws/YOUR_ID_HJWS \

Delete HJWS

DELETE https://api.3vidence.com//htsp/hjws

Request Body

Name

Type

Description

api_key

string

YOUR_API_KEY

id_hjws

string

YOUR_ID_HJWS

{
  "branch": "Resource deleted"
}

curl --request DELETE \
  --url https://api.3vidence.com//htsp/hjws \
  --header 'content-type: application/json' \
  --data '{"api_key": "YOUR_API_KEY",
  "id_hjws":"YOUR_ID_HJWS"}'

Get API key info

GET https://api.3vidence.com//htsp/info/apikey

Request Body

Name

Type

Description

api_key

string

YOUR_API_KEY

{
  "kid": "YOUR_KID",
  "ops": {
    "max_ops": 500,
    "total_ops": 0,
    "max_docs": 200,
    "total_docs": 0,
    "max_hjws": 200,
    "total_hjws": 1
  },
  "hjws": [
    {
      "id_hjws": "YOUR_ID_HJWS",
      "desc": "0545 cli"
    }
  ],
  "pubkey": {
    "EdDSA": {
      "algorithm": "ED25519",
      "pubkey": "PUBKEY",
      "error": ""
    },
    "RSA": {
      "algorithm": "RSA",
      "pubkey": "PUBKEY",
      "error": ""
    },
    "suite": "ed25519+rsa",
    "timestamp": 1602548344672
  }
}

curl --request POST \
  --url https://api.3vidence.com//htsp/info/apikey \
  --header 'content-type: application/json' \
  --data '{"api_key": "YOUR_API_KEY"}'

Get account info

GET https://api.3vidence.com//htsp/info

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT

{
  "user": {
    "max_subject": 2,
    "total_subject": 1,
    "max_branch": 4,
    "total_branch": 1
  },
  "branch": [
    {
      "created_at": "2020-10-13T00:18:26.000Z",
      "subject": "YOUR_EMAIL",
      "id_sec": "YOUR_ID_SEC",
      "enable": 1,
      "brn_created_at": "2020-10-13T00:19:04.000Z",
      "branch": "0545",
      "kid": "YOUR_KID",
      "max_ops": 500,
      "total_ops": 1,
      "max_docs": 200,
      "total_docs": 0,
      "max_hjws": 200,
      "total_hjws": 1
    }
  ],
  "subject": [
    {
      "id_sec": "YOUR_ID_SEC",
      "subject": "[email protected]",
      "id_user": "YOUR_ID_USER",
      "created_at": "2020-10-13T00:18:26.000Z",
      "type": "email"
    }
  ],
  "hjws": [
    {
      "kid": "YOUR_KID",
      "kid_hjws": [
        {
          "id_hjws": "YOUR_ID_HJWS",
          "desc": "0545 cli"
        }
      ]
    }
  ],
  "snippet": []
}

curl --request GET \
  --url https://api.3vidence.com//htsp/info \
  --header 'authorization: YOUR_LOGIN_JWT'

Delete your account

DELETE https://api.3vidence.com//htsp/account

Headers

Name

Type

Description

authorization

string

YOUR_LOGIN_JWT

curl --request DELETE \
  --url https://api.3vidence.com//htsp/account \
  --header 'authorization: YOUR_LOGIN_JWT'

Snippets

Check Snippets Health

GET https://api.3vidence.com/snippets/health

{
  "db": "Ok",
  "e115": {
    "db": "Ok",
    "crypto": "Ok",
    "http": "Ok"
  },
  "http": "Ok"
}

Check snippets status systems

curl --request GET \
  --url https://api.3vidence.com/snippets/health

Create a snippet

POST https://api.3vidence.com/snippets

Request Body

Name

Type

Description

algorithm

string

["sha224","sha3224","sha256","sha3_256","sha384","sha3_384","sha512","sha3_512","whirlpool"]

data

object

YOUR_JSON_DATA

api_key

string

YOUR_API_KEY

{
  "id_data": "833CF4048A6DC0DBB7D846DC14A4BE30BFC8B1E01828CA4BC911FFC9BA37F339",
  "id_hjws": "3B80AA97514686CC46B9E77003D85D1AE8674CCCFE2FB7E706EA039ED9220374"
}

curl --request POST \
  --url https://api.3vidence.com/snippets \
  --header 'content-type: application/json' \
  --data '{
  "api_key": "YOUR_API_KEY",
	"data":{
			YOUR_JSON_DATA
	},
	"algorithm":"HASH_ALGORITHM", 
	"desc": "YOUR_DESCRIPTION"
}'

Get a snippet

GET https://api.3vidence.com//snippets/data/YOUR_ID_DATA

curl --request GET \
  --url https://api.3vidence.com//snippets/data/YOUR_ID_DATA

Get snippet raw

Get a raw snippet

GET https://api.3vidence.com//snippets/data/YOUR_ID_DATA/sign

curl --request GET \
  --url https://api.3vidence.com//snippets/data/YOUR_ID_DATA/sign

Update a snippet

PUT https://api.3vidence.com//snippets

Request Body

Name

Type

Description

desc

string

YOUR_DESCRIPTION

algorithm

string

["sha224","sha3224","sha256","sha3_256","sha384","sha3_384","sha512","sha3_512","whirlpool"]

id_data

string

YOUR_ID_DATA

data

object

YOUR_JSON_DATA

api_key

string

YOUR_API_KEY

curl --request PUT \
  --url https://api.3vidence.com//snippets \
  --header 'content-type: application/json' \
  --data '{
  "api_key": "YOUR_API_KEY",
	"data":{
			YOUR_JSON_DATA
	},
	"id_data":"YOUR_ID_DATA",
	"algorithm":"HASH_ALGORITHM", 
	"desc": "YOUR_DESCRIPTION"
}'

Delete a snippet

DELETE https://api.3vidence.com//snippets

Request Body

Name

Type

Description

id_data

string

YOUR_ID_DATA

api_key

string

YOUR_API_KEY

{
  "snippets": "Resource deleted"
}

curl --request DELETE \
  --url https://api.3vidence.com//snippets \
  --header 'content-type: application/json' \
  --data '{
  "api_key": "YOUR_API_KEY",
  "id_data":"YOUR_ID_DATA"
}'

Get snippets info

GET https://api.3vidence.com/snippets/info

Request Body

Name

Type

Description

api_key

string

YOUR_API_KEY

{
  "snippets": [
    {
      "id_data": "0E639733B37D74EE758744D35E22860147E3D0A7D10253DD5B63370B49071A3B",
      "desc": "test",
      "id_hjws": "5978BB0177546EFF65189545B116DB44791A699E85294DD3E2E6D4C536956DA2"
    }
  ]
}

curl --request POST \
  --url https://api.3vidence.com//snippets/info \
  --header 'content-type: application/json' \
  --data '{
  "api_key": "YOUR_API_KEY"
}'

PreviousQuickstart

Last updated 3 years ago

hashtagAuth

hashtagCheck Auth health

hashtagVerify your account

hashtagPath Parameters

hashtagLogin

hashtagRequest Body

hashtagUpdate your password

hashtagHeaders

hashtagHTSP

hashtagCheck HTSP health

hashtagCreate a subject

hashtagHeaders

hashtagRequest Body

hashtagVerify your subject

hashtagPath Parameters

hashtagHeaders

hashtagDelete a subject

hashtagHeaders

hashtagRequest Body

hashtagCreate a branch

hashtagHeaders

hashtagRequest Body

hashtagDelete a branch

hashtagPath Parameters

hashtagHeaders

hashtagUpdate API key password

hashtagPath Parameters

hashtagRequest Body

hashtagPublic key info

hashtagSign anonymously

hashtagRequest Body

hashtagSign

hashtagRequest Body

hashtagVerify

hashtagRequest Body

hashtagUpload HJWS

hashtagRequest Body

hashtagRead HWJS

hashtagDelete HJWS

hashtagRequest Body

hashtagGet API key info

hashtagRequest Body

hashtagGet account info

hashtagHeaders

hashtagDelete your account

hashtagHeaders

hashtagSnippets

hashtagCheck Snippets Health

hashtagCreate a snippet

hashtagRequest Body

hashtagGet a snippet

hashtagGet a raw snippet

hashtagUpdate a snippet

hashtagRequest Body

hashtagDelete a snippet

hashtagRequest Body

hashtagGet snippets info

hashtagRequest Body

Auth

Check Auth health

Verify your account

Path Parameters

Login

Request Body

Update your password

Headers

HTSP

Check HTSP health

Create a subject

Headers

Request Body

Verify your subject

Path Parameters

Headers

Delete a subject

Headers

Request Body

Create a branch

Headers

Request Body

Delete a branch

Path Parameters

Headers

Update API key password

Path Parameters

Request Body

Public key info

Sign anonymously

Request Body

Sign

Request Body

Verify

Request Body

Upload HJWS

Request Body

Read HWJS

Delete HJWS

Request Body

Get API key info

Request Body

Get account info

Headers

Delete your account

Headers

Snippets

Check Snippets Health

Create a snippet

Request Body

Get a snippet

Get a raw snippet

Update a snippet

Request Body

Delete a snippet

Request Body

Get snippets info

Request Body