githubEdit

iREC API Demo Guide

Standard Registry

Create Root Account

Creating Standard Registry

POST /account

To create a Root Account

Request Body

Name
Type
Description

username*

String

rootUsername

password*

String

rootPassword

role*

String

STANDARD_REGISTRY

{
    "username": "1tckto80",
    "password": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "did": null,
    "parent": null,
    "role": "STANDARD_REGISTRY",
    "id": "627d4b99ab3cae7c07025893"
}

Login as Standard Registry

Login to the Root Account

POST /accounts/login

Login as Standard Registry

Request Body

Name
Type
Description

username*

String

username

password*

String

Password

Generating Root Key

To Generate Root Key

GET /demo/randomKey

Generating Root Key

Update Root Profile

Updating Profile of Standard Registry

PUT /profiles/{rootUsername}

Request Body

Name
Type
Description

hederaAccountID*

String

rootID

hederaAccountKey*

Key

rootKey

vcDocument

Array

Get Root Profile

Getting Standard Registry Profile Details

GET /profiles/{rootUsername}

User

Create User Account

Creating User Account

POST /accounts/register

Request Body

Name
Type
Description

username*

String

rootUsername

password*

String

rootPassword

role*

String

USER

Login to User Account

Login as User

POST /accounts/login

Request Body

Name
Type
Description

username*

String

rootUsername

password*

String

rootPassword

Generate User Key

Generating User Key

GET /demo/randomKey

Update User Profile

Updating User Profiles

PUT /profiles/{userUsername}

Request Body

Name
Type
Description

hederaAccountID*

ID

UserID

hederaAccountKey*

Key

UserKey

parent*

DID

rootDID

Get User Profile

Getting User Profile Details

GET /profiles/{userUsername}

Policy

New Policy

Import Policy

Importing Policy

POST /policies/import/message

Request Body

Name
Type
Description

messageID*

ID

1651598638.021817000

Publish Policy

Publishing Policy

PUT /policies/{policyId}/publish

Request Body

Name
Type
Description

policyVersion*

String

1.0.0

Tokens

Get Tokens

Getting Tokens Details

GET /tokens

Associate

Associating the Token

PUT /tokens/{token_Id}/associate

Grant KYC

Granting KYC

PUT /tokens/{tokenId}/{userUsername}/grantKYC

Blocks

Choose Role uuid

Choosing Role

GET /policies/{{policyId}}/tag/choose_role

Choose Role

Choosing role as Registrant

POST /policies/{{policyId}}/blocks/{{chooseRoleBlockUUID}}

Create Application uuid

Displaying Application uuid

GET /policies/{{policyId}}/tag/create_application

Get Registrant Schema

Displaying Registrant Schema uuid

GET policies/{{policyId}}/blocks/{{create_application_uuid}}

Create Registrant

Creating Registrant

POST /policies/{{policyId}}/blocks/{{create_application_uuid}}

Request Body

Name
Type
Description

document

String

{ "type": "{{registrant_schema_type}}", "@context": [ "{{registrant_schema_context}}" ], "field0": "2022-05-11", "field1": { "type": "{{registrant_schema_field1_type}}", "@context": [ "{{registrant_schema_field1_context}}" ], "field0": "Applicant Legal Name", "field1": "Registered address line 1", "field2": "Registered address line 2", "field3": "Registered address line 3", "field4": "Postal (ZIP) code", "field5": "Country", "field6": "Legal Status", "field7": "Country of company registration/private residence", "field8": "Corporate registration number/passport number", "field9": "VAT number", "field10": "Website URL", "field11": "Main business (e.g. food retailer)", "field12": 1, "field13": 1, "field14": "Name of the Chief Executive Officer/General Manager", "field15": "Chief Executive Officer/General Manager passport number", "field16": "Please state in which countries the organization is active", "field17": "Please list the main (>10%) shareholders", "field18": 1, "field19": "[email protected]" }, "field2": { "type": "{{registrant_schema_field2_type}}", "@context": [ "{{registrant_schema_field2_context}}" ], "field0": "Organization Name", "field1": "Address line 1", "field2": "Address line 2", "field3": "Address line 3", "field4": "Postal code", "field5": "Country", "field6": "Contact person", "field7": "[email protected]", "field8": "123456789", "field9": "Fax", "field10": "Existing I-REC Registry organization(s) to become subsidiary" }, "field3": { "type": "{{registrant_schema_field3_type}}", "@context": [ "{{registrant_schema_field3_context}}" ], "field0": "Family Name (surname)", "field1": "Other (Given) Names", "field2": "Title", "field3": "[email protected]", "field4": "123456789", "field5": "Fax" }

ref

String

null

Get Approved Registrant

Displaying Approved Registrant uuid

GET /policies/{{policyId}}/tag/approve_registrant_btn

Get Grid Documents

Displaying Grid Documents

GET /policies/{{policyId}}/blocks/{{registrants_grid_uuid}}

Approve Registrant

Approving Registrant

POST /policies/{{policyId}}/blocks/{{approve_registrant_btn_uuid}}

Request Body

Name
Type
Description

reg

String

Getting uuid of device created

Getting uuid of created device

GET /policies/{{policyId}}/tag/create_device_form

Getting Device Schema

Device Schema Details

GET /policies/{{policyId}}/blocks/{{create_device_form_uuid}}

Create Device

Creating Device

POST /policies/{{policyId}}/blocks/{{create_device_form_uuid}}

Request Body

Name
Type
Description

*

String

{{req_body}}

Getting Approve Device Button UUID

Getting UUID of Approved Device Button

GET /policies/{{policyId}}/tag/approve_device_btn

Getting Approve Device Grid UUID

Getting UUID of Approve Device Grid

GET /policies/{{policyId}}/tag/approve_devices_grid

Get Grid Documents

Getting Grid Documents

GET /policies/{{policyId}}/blocks/{{approve_devices_grid_uuid}}

Approve Device

Approving Device

POST /policies/{{policyId}}/blocks/{{approve_device_btn_uuid}}

Request Body

Name
Type
Description

String

{{req_body}}

Getting UUID of Create Issue Request

Getting Create Issue Request UUID

GET /policies/{{policyId}}/tag/create_issue_request_form

Getting Grid UUID

Getting Grid UUID

GET /policies/{{policyId}}/tag/approve_devices_grid

Getting Grid Documents

Displaying Grid Documents

GET /policies/{{policyId}}/blocks/{{issue_grid_uuid}}

Getting Issue Schema

Getting Schema of Issue Request

GET /policies/{{policyId}}/blocks/{{create_issue_request_form_uuid}}

Create Issue Request

Creating Issue Request

POST /policies/{{policyId}}/blocks/{{create_issue_request_form_uuid}}

Request Body

Name
Type
Description

String

{{req_body}}

Getting Approve Request Button UUID

Getting Approve Request Button UUID

GET /policies/{{policyId}}/tag/approve_issue_requests_btn

Getting Issue Request Grid UUID

Getting Issue Request Grid UUID

GET /policies/{{policyId}}/tag/issue_requests_grid(evident)

Getting Approve Issue Grid Documents

Getting Grid Documents of Approve Issue

GET /policies/{{policyId}}/blocks/{{approve_issue_grid_uuid}}

Approve Issue Request

Approving Issue Request

POST policies/{{policyId}}/blocks/{{approve_issue_requests_btn_uuid}}

Request Body

Name
Type
Description

String

{{req_body}}

TrustChain

Getting Grid UUID

Getting Grid UUID

GET /policies/{{policyId}}/tag/vp_grid

Getting Grid Documents

Getting Grid Documents

GET /policies/{{policyId}}/blocks/{{vpGridBlock_uuid}}

Getting TrustChain Block UUID

Getting TrustChain Block UUID

GET /policies/{{policyId}}/tag/trustChainBlock

Setting Hash Filter

Setting Hash Filter

POST /policies/{{policyId}}/blocks/{{trustChainBlock_uuid}}

Getting TrustChain Block Data

Getting TrustChain Block Data

GET /policies/{{policyId}}/blocks/{{trustChainBlock_uuid}}

Last updated

Was this helpful?