Data Agreement - Auditor Functions

Mark a connection as Auditor.Fetch current connection marked as Auditor Unmark current connection marked as Auditor Fetch Auditor DIDComm transaction records Fetch Auditor DIDComm transaction record by ID Remove Auditor DIDComm transaction record by ID Send data agreement verify request to the auditor

Data Agreement - Core Functions

Send read data agreement message to Data Controller (remote agent)List data agreements crud didcomm transactions from the wallet Remove data agreement CRUD DIDComm transaction record by ID Create and store data agreement in wallet (v2)Query data agreements in the wallet Publish data agreement in the wallet Update data agreement in the wallet (v2)Delete data agreement in the wallet Query version history of a data agreement Query data agreement personal data in wallet Update data agreement personal data in wallet Delete data agreement personal data in wallet Query data agreement instances Generate Data Agreement QR code payload Query Data Agreement QR code metadata records Base64 encode data agreement qr code payload Generate firebase dynamic link for data agreement qr code payload.Delete Data Agreement QR code record.Send data agreement qr code workflow initiate message to remote agent Send read all data agreement template message to remote agent.

Data Agreement - MyData DID Operations

Fetch MyData DID registry transaction records Fetch MyData DID registry DIDComm transaction record by ID Remove MyData DID registry DIDComm transaction record by ID Send create-did didcomm message to MyData DID registry Send read-did didcomm message to MyData DID registry Send delete-did message Fetch MyData DID remote records.Mark a connection as MyData DID registry.Fetch current connection marked as MyData DID registry Unmark current connection marked as MyData DID registry Dummy MyData DID resolve route

Data Agreement - MyData DID Registry Admin Functions

Fetch all registered MyData DIDs

Data Controller

Send data controller details message to remote agent hosted by Data Controller

Send JSON-LD processed-data didcomm message to the remote agent.

Close the active menu associated with a connection Fetch the active menu Perform an action associated with the active menu Request the active menu Send an action menu to a connection

Send a basic message to a connection

Query agent-to-agent connections Fetch a single connection record Remove an existing connection record Create a new static connection Create a new connection invitation Receive a new connection invitation Accept a stored connection invitation Accept a stored connection request Assign another connection as the inbound connection Well-known endpoint for connection Create a new connection invitation (Overridden API)Generate firebase dynamic link for connection invitation Send existing connections message to remote agent.Fetch existing connection details if any for a current connection.Query agent-to-agent connections (v2)

credential-definition

Sends a credential definition to the ledger Search for matching credential definitions that agent originated Gets a credential definition from the ledger

Fetch a credential from wallet by id Remove a credential from the wallet by id Query credential revocation status by id Get attribute MIME types from wallet Fetch credentials from wallet

Start an introduction between two connections

issue-credential

Fetch all credential exchange records Fetch a single credential exchange record Remove an existing credential exchange record Send holder a credential, automating entire flow Send holder a credential, automating entire flow Send issuer a credential proposal Send holder a credential offer, independent of any proposal Send holder a credential offer in reference to a proposal with preview Send issuer a credential request Send holder a credential Store a received credential Send a problem report for credential exchange Send data agreement reject message for a credential offer Send data agreement negotiation problem report message Send data agreement termination message.

Send a NYM registration to the ledger.Get the role from the NYM registration of a public DID.Rotate key pair for public DID.Get the verkey for a DID from the ledger.Get the endpoint for a DID from the ledger.Fetch the current transaction author agreement, if any Accept the transaction author agreement

Create a new connection invitation Create a new connection invitation

Fetch all present-proof exchange records Fetch a single presentation exchange record Remove an existing presentation exchange record Fetch credentials for a presentation request from wallet Sends a presentation proposal Creates a presentation request not bound to any proposal or existing connection Sends a free presentation request not bound to any proposal Sends a presentation request in reference to a proposal Sends a proof presentation Verify a received presentation Send a presentation request in reference to a data agreement Send data agreement reject message for a presentation request Send data agreement negotiation problem report message Send data agreement termination message.

Sends a schema to the ledger Search for matching schema that agent originated Gets a schema from the ledger

List wallet DIDs Create a local DID Fetch the current public DID Assign the current public DID Update endpoint in wallet and on ledger if posted to it Query DID endpoint in wallet Rotate keypair for a DID not posted to the ledger

Getting started

2.0 Define Data Agreements

Create data agreement Fetch data agreement Update data agreement Delete data agreement

4.0 Implement APIs-4.1 Establishing connection with Cloud/Mobile wallets

Fetch connection record Create a new connection invitation Create Firebase dynamic link for connection record

4.0 Implement APIs-4.2 Issue/expose data to a connection (Data Source)

Fetch credential issuance history record Issue credential to connection

4.0 Implement APIs-4.3 Verify/consume data from a connection (Data Using Service)

Fetch verification history record Send verification request to connection Create verification QR code Create Firebase dynamic link for verification

5.0 Enable webhooks and subscribe to events-5.1 Configure webhook URL

iGrant.io API documentation

LIST - Fetch all organisational logs LIST - Fetch all consent records READ - Get consent record LIST - Fetch all data agreements READ - Get data agreement

CREATE - Create data agreement READ - Read data agreement UPDATE - Update data agreement DELETE - Delete data agreement LIST - List all data agreements LIST - List data agreement revisions READ - Read data attributes UPDATE - Update data attribute LIST - List all data attributes CREATE - Create data policy READ - Read data policy UPDATE - Update data policy DELETE - Delete data policy LIST - List all data policies LIST - List data policy revisions CREATE - Create individual READ - Read individual UPDATE - Update individual LIST - List all individuals CREATE - Create individual(s) via csv CREATE - Create webhook READ - Read webhook UPDATE - Update webhook DELETE - Delete webhook LIST - List all webhooks Ping webhook LIST - List all webhook deliveries READ - Read webhook delivery Re-deliver a webhook event READ - Read webhook event types LIST - List all webhook content types CREATE - Create IDP READ - Read IdP details UPDATE - Update IDP DELETE - Delete an IDP LIST - List all IdPs LIST - List all api keys CREATE - Create API key UPDATE - Update API key DELETE - Delete API key

READ - Read organisation cover image READ - Read organisation logo image READ - Read IdP details READ - Read organisation LIST - List all active data agreements READ - Read data agreement LIST - List data attributes READ - Read data policy LIST - List all data agreements READ - Read latest consent record LIST - List all consent records CREATE - Create consent record READ - Read consent record CREATE - Create draft consent record CREATE - Create consent record and signature LIST - List all consent records for individual DELETE - Delete all consent records UPDATE - Update consent record CREATE - Creates blank signature UPDATE - Update consent record signature LIST - List all consent records LIST - List consent record history CREATE - Create individual READ - Read individual UPDATE - Update individual LIST - List all individuals READ - Read organisation image READ - Read data sharing UI

UPDATE - Update organisation admin onboard Get Admin CREATE - Register organisation admin UPDATE - Update organisation admin avatar image onboard Get Admin Avatar onboard Reset Password onboard Forgot Password login Organisation Admin login Individual logout get Organisation CREATE - Add organization update Organisation get Organisation Cover Image update Organisation Cover Image get Organisation Logo Image update Organisation Logo Image READ - Read organisation image refresh Token exchange Code For Token onboard Read Status CREATE - Validate phone CREATE - Validate email CREATE - Verify phone CREATE - Verify OTP READ - Read organisation

READ - Read Billing Plans READ - Read Billing CREATE - Register Billing UPDATE - Update Billing CREATE - Add Billing Address CREATE - Add Billing PaymentSource CREATE - Add Billing Subscribe Plan DELETE - Cancel billing plan READ - Read Billing Subscribe Plan READ - Read Invoices READ - Read Service Agreement Url CREATE - Process billing webhook

CREATE - Add data verifier user READ - Read data verifier user UPDATE - Update data verifier user DELETE - Delete data verifier user LIST - List all data verifier users CREATE - Send magic link READ - Redirect magic link onboard Resolve Magic Link

organisation type

CREATE - Add organization Type READ - Read organization type UPDATE - Update organisation type DELETE - Delete organization type LIST - List all organisation types

user request (individual)

READ - Read delete my data CREATE - Create delete my data request READ - Read delete my data status CANCEL - Cancel delete mydata user request READ - Read download my data request CREATE - Create download my data request READ - Read download my data status CANCEL - Cancel download mydata user request READ - Read update my data CREATE - Create update my data request READ - Read update mydata status CANCEL - Cancel update mydata user request READ - Read data request status

user request (organisation admin)

READ - Read data request UPDATE - Update data requests LIST - List data requests

deployment (privacy dashboard)

GET - Read privacy dashboard versions GET - Read privacy dashboard CREATE - Deploy privacy dashboard DELETE - Delete privacy dashboard UPDATE - Update privacy dashboard version UPDATE - Update privacy dashboard hostname

deployment (digital wallet)

GET - Read digital wallet versions GET - Read digital wallet CREATE - Deploy digital wallet DELETE - Delete digital wallet UPDATE - Update digital wallet version UPDATE - Update auto respond credential proposal startup command UPDATE - Update digital wallet webhook url DELETE - Delete digital wallet webhook url GET - Read digital wallet status list GET - Read ledger network with genesis transactions GET - Read ledger network list CREATE - Enable tls READ - Read tls status UPDATE - Disable tls READ - Read predefined self attested verificate templates

READ - Read Organisation Identifier CREATE - Create Connection Invitation CREATE - Receive Connection Invitation delete Connection LIST - List all connections Create - Issue Credential list Credential History delete Credential History Create - Send verification request list Verification History delete Verification History CREATE - Create Verification QR CREATE - Create Firebase dynamic link for verification QR connection Webhook issue Credential Webhook verification Webhook READ - Read Schema

Data Agreement - Auditor Functions

Mark a connection as Auditor.Fetch current connection marked as Auditor Unmark current connection marked as Auditor Fetch Auditor DIDComm transaction records Fetch Auditor DIDComm transaction record by ID Remove Auditor DIDComm transaction record by ID Send data agreement verify request to the auditor

Data Agreement - Core Functions

Send read data agreement message to Data Controller (remote agent)List data agreements crud didcomm transactions from the wallet Remove data agreement CRUD DIDComm transaction record by ID Create and store data agreement in wallet (v2)Query data agreements in the wallet Publish data agreement in the wallet Update data agreement in the wallet (v2)Delete data agreement in the wallet Query version history of a data agreement Query data agreement personal data in wallet Update data agreement personal data in wallet Delete data agreement personal data in wallet Query data agreement instances Generate Data Agreement QR code payload Query Data Agreement QR code metadata records Base64 encode data agreement qr code payload Generate firebase dynamic link for data agreement qr code payload.Delete Data Agreement QR code record.Send data agreement qr code workflow initiate message to remote agent Send read all data agreement template message to remote agent.

Data Agreement - MyData DID Operations

Fetch MyData DID registry transaction records Fetch MyData DID registry DIDComm transaction record by ID Remove MyData DID registry DIDComm transaction record by ID Send create-did didcomm message to MyData DID registry Send read-did didcomm message to MyData DID registry Send delete-did message Fetch MyData DID remote records.Mark a connection as MyData DID registry.Fetch current connection marked as MyData DID registry Unmark current connection marked as MyData DID registry Dummy MyData DID resolve route

Data Agreement - MyData DID Registry Admin Functions

Fetch all registered MyData DIDs

Data Controller

Send data controller details message to remote agent hosted by Data Controller

Send JSON-LD processed-data didcomm message to the remote agent.

Close the active menu associated with a connection Fetch the active menu Perform an action associated with the active menu Request the active menu Send an action menu to a connection

Send a basic message to a connection

Query agent-to-agent connections Fetch a single connection record Remove an existing connection record Create a new static connection Create a new connection invitation Receive a new connection invitation Accept a stored connection invitation Accept a stored connection request Assign another connection as the inbound connection Well-known endpoint for connection Create a new connection invitation (Overridden API)Generate firebase dynamic link for connection invitation Send existing connections message to remote agent.Fetch existing connection details if any for a current connection.Query agent-to-agent connections (v2)

credential-definition

Sends a credential definition to the ledger Search for matching credential definitions that agent originated Gets a credential definition from the ledger

Fetch a credential from wallet by id Remove a credential from the wallet by id Query credential revocation status by id Get attribute MIME types from wallet Fetch credentials from wallet

Start an introduction between two connections

issue-credential

Fetch all credential exchange records Fetch a single credential exchange record Remove an existing credential exchange record Send holder a credential, automating entire flow Send holder a credential, automating entire flow Send issuer a credential proposal Send holder a credential offer, independent of any proposal Send holder a credential offer in reference to a proposal with preview Send issuer a credential request Send holder a credential Store a received credential Send a problem report for credential exchange Send data agreement reject message for a credential offer Send data agreement negotiation problem report message Send data agreement termination message.

Send a NYM registration to the ledger.Get the role from the NYM registration of a public DID.Rotate key pair for public DID.Get the verkey for a DID from the ledger.Get the endpoint for a DID from the ledger.Fetch the current transaction author agreement, if any Accept the transaction author agreement

Create a new connection invitation Create a new connection invitation

Fetch all present-proof exchange records Fetch a single presentation exchange record Remove an existing presentation exchange record Fetch credentials for a presentation request from wallet Sends a presentation proposal Creates a presentation request not bound to any proposal or existing connection Sends a free presentation request not bound to any proposal Sends a presentation request in reference to a proposal Sends a proof presentation Verify a received presentation Send a presentation request in reference to a data agreement Send data agreement reject message for a presentation request Send data agreement negotiation problem report message Send data agreement termination message.

Sends a schema to the ledger Search for matching schema that agent originated Gets a schema from the ledger

List wallet DIDs Create a local DID Fetch the current public DID Assign the current public DID Update endpoint in wallet and on ledger if posted to it Query DID endpoint in wallet Rotate keypair for a DID not posted to the ledger

Getting started

2.0 Define Data Agreements

Create data agreement Fetch data agreement Update data agreement Delete data agreement

4.0 Implement APIs-4.1 Establishing connection with Cloud/Mobile wallets

Fetch connection record Create a new connection invitation Create Firebase dynamic link for connection record

4.0 Implement APIs-4.2 Issue/expose data to a connection (Data Source)

Fetch credential issuance history record Issue credential to connection

4.0 Implement APIs-4.3 Verify/consume data from a connection (Data Using Service)

Fetch verification history record Send verification request to connection Create verification QR code Create Firebase dynamic link for verification

5.0 Enable webhooks and subscribe to events-5.1 Configure webhook URL

iGrant.io API documentation

LIST - Fetch all organisational logs LIST - Fetch all consent records READ - Get consent record LIST - Fetch all data agreements READ - Get data agreement

CREATE - Create data agreement READ - Read data agreement UPDATE - Update data agreement DELETE - Delete data agreement LIST - List all data agreements LIST - List data agreement revisions READ - Read data attributes UPDATE - Update data attribute LIST - List all data attributes CREATE - Create data policy READ - Read data policy UPDATE - Update data policy DELETE - Delete data policy LIST - List all data policies LIST - List data policy revisions CREATE - Create individual READ - Read individual UPDATE - Update individual LIST - List all individuals CREATE - Create individual(s) via csv CREATE - Create webhook READ - Read webhook UPDATE - Update webhook DELETE - Delete webhook LIST - List all webhooks Ping webhook LIST - List all webhook deliveries READ - Read webhook delivery Re-deliver a webhook event READ - Read webhook event types LIST - List all webhook content types CREATE - Create IDP READ - Read IdP details UPDATE - Update IDP DELETE - Delete an IDP LIST - List all IdPs LIST - List all api keys CREATE - Create API key UPDATE - Update API key DELETE - Delete API key

READ - Read organisation cover image READ - Read organisation logo image READ - Read IdP details READ - Read organisation LIST - List all active data agreements READ - Read data agreement LIST - List data attributes READ - Read data policy LIST - List all data agreements READ - Read latest consent record LIST - List all consent records CREATE - Create consent record READ - Read consent record CREATE - Create draft consent record CREATE - Create consent record and signature LIST - List all consent records for individual DELETE - Delete all consent records UPDATE - Update consent record CREATE - Creates blank signature UPDATE - Update consent record signature LIST - List all consent records LIST - List consent record history CREATE - Create individual READ - Read individual UPDATE - Update individual LIST - List all individuals READ - Read organisation image READ - Read data sharing UI

UPDATE - Update organisation admin onboard Get Admin CREATE - Register organisation admin UPDATE - Update organisation admin avatar image onboard Get Admin Avatar onboard Reset Password onboard Forgot Password login Organisation Admin login Individual logout get Organisation CREATE - Add organization update Organisation get Organisation Cover Image update Organisation Cover Image get Organisation Logo Image update Organisation Logo Image READ - Read organisation image refresh Token exchange Code For Token onboard Read Status CREATE - Validate phone CREATE - Validate email CREATE - Verify phone CREATE - Verify OTP READ - Read organisation

READ - Read Billing Plans READ - Read Billing CREATE - Register Billing UPDATE - Update Billing CREATE - Add Billing Address CREATE - Add Billing PaymentSource CREATE - Add Billing Subscribe Plan DELETE - Cancel billing plan READ - Read Billing Subscribe Plan READ - Read Invoices READ - Read Service Agreement Url CREATE - Process billing webhook

CREATE - Add data verifier user READ - Read data verifier user UPDATE - Update data verifier user DELETE - Delete data verifier user LIST - List all data verifier users CREATE - Send magic link READ - Redirect magic link onboard Resolve Magic Link

organisation type

CREATE - Add organization Type READ - Read organization type UPDATE - Update organisation type DELETE - Delete organization type LIST - List all organisation types

user request (individual)

READ - Read delete my data CREATE - Create delete my data request READ - Read delete my data status CANCEL - Cancel delete mydata user request READ - Read download my data request CREATE - Create download my data request READ - Read download my data status CANCEL - Cancel download mydata user request READ - Read update my data CREATE - Create update my data request READ - Read update mydata status CANCEL - Cancel update mydata user request READ - Read data request status

user request (organisation admin)

READ - Read data request UPDATE - Update data requests LIST - List data requests

deployment (privacy dashboard)

GET - Read privacy dashboard versions GET - Read privacy dashboard CREATE - Deploy privacy dashboard DELETE - Delete privacy dashboard UPDATE - Update privacy dashboard version UPDATE - Update privacy dashboard hostname

deployment (digital wallet)

GET - Read digital wallet versions GET - Read digital wallet CREATE - Deploy digital wallet DELETE - Delete digital wallet UPDATE - Update digital wallet version UPDATE - Update auto respond credential proposal startup command UPDATE - Update digital wallet webhook url DELETE - Delete digital wallet webhook url GET - Read digital wallet status list GET - Read ledger network with genesis transactions GET - Read ledger network list CREATE - Enable tls READ - Read tls status UPDATE - Disable tls READ - Read predefined self attested verificate templates

READ - Read Organisation Identifier CREATE - Create Connection Invitation CREATE - Receive Connection Invitation delete Connection LIST - List all connections Create - Issue Credential list Credential History delete Credential History Create - Send verification request list Verification History delete Verification History CREATE - Create Verification QR CREATE - Create Firebase dynamic link for verification QR connection Webhook issue Credential Webhook verification Webhook READ - Read Schema

Home Digital Wallet Data Agreement - Core FunctionsDelete Data Agreement QR code record.

Delete Data Agreement QR code record.

DELETE {{baseUrl}}/v1/data-agreements/:data_agreement_id/qr/:qr_id

Generate firebase dynamic link for data agreement qr code payload.

Send data agreement qr code workflow initiate message to remote agent