Qodex.ai
Qodex.ai
Introduction
Digital Wallet
Data Agreement - Auditor Functions
Mark a connection as Auditor.Fetch current connection marked as AuditorUnmark current connection marked as AuditorFetch Auditor DIDComm transaction recordsFetch Auditor DIDComm transaction record by IDRemove Auditor DIDComm transaction record by IDSend 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 walletRemove data agreement CRUD DIDComm transaction record by IDCreate and store data agreement in wallet (v2)Query data agreements in the walletPublish data agreement in the walletUpdate data agreement in the wallet (v2)Delete data agreement in the walletQuery version history of a data agreementQuery data agreement personal data in walletUpdate data agreement personal data in walletDelete data agreement personal data in walletQuery data agreement instancesGenerate Data Agreement QR code payloadQuery Data Agreement QR code metadata recordsBase64 encode data agreement qr code payloadGenerate 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 agentSend read all data agreement template message to remote agent.
Data Agreement - MyData DID Operations
Fetch MyData DID registry transaction recordsFetch MyData DID registry DIDComm transaction record by IDRemove MyData DID registry DIDComm transaction record by IDSend create-did didcomm message to MyData DID registrySend read-did didcomm message to MyData DID registrySend delete-did messageFetch MyData DID remote records.Mark a connection as MyData DID registry.Fetch current connection marked as MyData DID registryUnmark current connection marked as MyData DID registryDummy 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
JSON-LD
Send JSON-LD processed-data didcomm message to the remote agent.
action-menu
Close the active menu associated with a connectionFetch the active menuPerform an action associated with the active menuRequest the active menuSend an action menu to a connection
basicmessage
Send a basic message to a connection
connection
Query agent-to-agent connectionsFetch a single connection recordRemove an existing connection recordCreate a new static connectionCreate a new connection invitationReceive a new connection invitationAccept a stored connection invitationAccept a stored connection requestAssign another connection as the inbound connectionWell-known endpoint for connectionCreate a new connection invitation (Overridden API)Generate firebase dynamic link for connection invitationSend 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 ledgerSearch for matching credential definitions that agent originatedGets a credential definition from the ledger
credentials
Fetch a credential from wallet by idRemove a credential from the wallet by idQuery credential revocation status by idGet attribute MIME types from walletFetch credentials from wallet
introduction
Start an introduction between two connections
issue-credential
Fetch all credential exchange recordsFetch a single credential exchange recordRemove an existing credential exchange recordSend holder a credential, automating entire flowSend holder a credential, automating entire flowSend issuer a credential proposalSend holder a credential offer, independent of any proposalSend holder a credential offer in reference to a proposal with previewSend issuer a credential requestSend holder a credentialStore a received credentialSend a problem report for credential exchangeSend data agreement reject message for a credential offerSend data agreement negotiation problem report messageSend data agreement termination message.
ledger
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 anyAccept the transaction author agreement
out-of-band
Create a new connection invitationCreate a new connection invitation
present-proof
Fetch all present-proof exchange recordsFetch a single presentation exchange recordRemove an existing presentation exchange recordFetch credentials for a presentation request from walletSends a presentation proposal Creates a presentation request not bound to any proposal or existing connection Sends a free presentation request not bound to any proposalSends a presentation request in reference to a proposalSends a proof presentationVerify a received presentationSend a presentation request in reference to a data agreementSend data agreement reject message for a presentation requestSend data agreement negotiation problem report messageSend data agreement termination message.
schema
Sends a schema to the ledgerSearch for matching schema that agent originatedGets a schema from the ledger
wallet
List wallet DIDsCreate a local DIDFetch the current public DIDAssign the current public DIDUpdate endpoint in wallet and on ledger if posted to itQuery DID endpoint in walletRotate keypair for a DID not posted to the ledger
Create QR code
Getting started
2.0 Define Data Agreements
Create data agreementFetch data agreementUpdate data agreementDelete data agreement
4.0 Implement APIs-4.1 Establishing connection with Cloud/Mobile wallets
Fetch connection recordCreate a new connection invitationCreate Firebase dynamic link for connection record
4.0 Implement APIs-4.2 Issue/expose data to a connection (Data Source)
Fetch credential issuance history recordIssue credential to connection
4.0 Implement APIs-4.3 Verify/consume data from a connection (Data Using Service)
Fetch verification history recordSend verification request to connectionCreate verification QR codeCreate Firebase dynamic link for verification
5.0 Enable webhooks and subscribe to events-5.1 Configure webhook URL
Endpoint
iGrant.io API documentation
audit
LIST - Fetch all organisational logsLIST - Fetch all consent recordsREAD - Get consent recordLIST - Fetch all data agreementsREAD - Get data agreement
config
CREATE - Create data agreementREAD - Read data agreementUPDATE - Update data agreementDELETE - Delete data agreementLIST - List all data agreementsLIST - List data agreement revisionsREAD - Read data attributesUPDATE - Update data attributeLIST - List all data attributesCREATE - Create data policyREAD - Read data policyUPDATE - Update data policyDELETE - Delete data policyLIST - List all data policiesLIST - List data policy revisionsCREATE - Create individualREAD - Read individualUPDATE - Update individualLIST - List all individualsCREATE - Create individual(s) via csvCREATE - Create webhookREAD - Read webhookUPDATE - Update webhookDELETE - Delete webhookLIST - List all webhooksPing webhookLIST - List all webhook deliveriesREAD - Read webhook deliveryRe-deliver a webhook eventREAD - Read webhook event typesLIST - List all webhook content typesCREATE - Create IDPREAD - Read IdP detailsUPDATE - Update IDPDELETE - Delete an IDPLIST - List all IdPsLIST - List all api keysCREATE - Create API keyUPDATE - Update API keyDELETE - Delete API key
service
READ - Read organisation cover imageREAD - Read organisation logo imageREAD - Read IdP detailsREAD - Read organisationLIST - List all active data agreementsREAD - Read data agreementLIST - List data attributesREAD - Read data policyLIST - List all data agreementsREAD - Read latest consent recordLIST - List all consent recordsCREATE - Create consent recordREAD - Read consent recordCREATE - Create draft consent recordCREATE - Create consent record and signatureLIST - List all consent records for individualDELETE - Delete all consent recordsUPDATE - Update consent recordCREATE - Creates blank signatureUPDATE - Update consent record signatureLIST - List all consent recordsLIST - List consent record historyCREATE - Create individualREAD - Read individualUPDATE - Update individualLIST - List all individualsREAD - Read organisation imageREAD - Read data sharing UI
onboard
UPDATE - Update organisation adminonboard Get AdminCREATE - Register organisation adminUPDATE - Update organisation admin avatar imageonboard Get Admin Avataronboard Reset Passwordonboard Forgot Passwordlogin Organisation Adminlogin Individuallogoutget OrganisationCREATE - Add organizationupdate Organisationget Organisation Cover Imageupdate Organisation Cover Imageget Organisation Logo Imageupdate Organisation Logo ImageREAD - Read organisation imagerefresh Tokenexchange Code For Tokenonboard Read StatusCREATE - Validate phoneCREATE - Validate emailCREATE - Verify phoneCREATE - Verify OTPREAD - Read organisation
billing
READ - Read Billing PlansREAD - Read BillingCREATE - Register BillingUPDATE - Update BillingCREATE - Add Billing AddressCREATE - Add Billing PaymentSourceCREATE - Add Billing Subscribe PlanDELETE - Cancel billing planREAD - Read Billing Subscribe PlanREAD - Read InvoicesREAD - Read Service Agreement UrlCREATE - Process billing webhook
data verifier
CREATE - Add data verifier userREAD - Read data verifier userUPDATE - Update data verifier userDELETE - Delete data verifier userLIST - List all data verifier usersCREATE - Send magic linkREAD - Redirect magic linkonboard Resolve Magic Link
organisation type
CREATE - Add organization TypeREAD - Read organization typeUPDATE - Update organisation typeDELETE - Delete organization typeLIST - List all organisation types
user request (individual)
READ - Read delete my dataCREATE - Create delete my data requestREAD - Read delete my data statusCANCEL - Cancel delete mydata user requestREAD - Read download my data requestCREATE - Create download my data requestREAD - Read download my data statusCANCEL - Cancel download mydata user requestREAD - Read update my dataCREATE - Create update my data requestREAD - Read update mydata statusCANCEL - Cancel update mydata user requestREAD - Read data request status
user request (organisation admin)
READ - Read data requestUPDATE - Update data requestsLIST - List data requests
deployment (privacy dashboard)
GET - Read privacy dashboard versionsGET - Read privacy dashboardCREATE - Deploy privacy dashboardDELETE - Delete privacy dashboardUPDATE - Update privacy dashboard versionUPDATE - Update privacy dashboard hostname
deployment (digital wallet)
GET - Read digital wallet versionsGET - Read digital walletCREATE - Deploy digital walletDELETE - Delete digital walletUPDATE - Update digital wallet versionUPDATE - Update auto respond credential proposal startup commandUPDATE - Update digital wallet webhook urlDELETE - Delete digital wallet webhook urlGET - Read digital wallet status listGET - Read ledger network with genesis transactionsGET - Read ledger network listCREATE - Enable tlsREAD - Read tls statusUPDATE - Disable tlsREAD - Read predefined self attested verificate templates
digital wallet
READ - Read Organisation IdentifierCREATE - Create Connection InvitationCREATE - Receive Connection Invitationdelete ConnectionLIST - List all connectionsCreate - Issue Credentiallist Credential Historydelete Credential HistoryCreate - Send verification requestlist Verification Historydelete Verification HistoryCREATE - Create Verification QRCREATE - Create Firebase dynamic link for verification QRconnection Webhookissue Credential Webhookverification WebhookREAD - Read Schema
Introduction
Digital Wallet
Data Agreement - Auditor Functions
Mark a connection as Auditor.Fetch current connection marked as AuditorUnmark current connection marked as AuditorFetch Auditor DIDComm transaction recordsFetch Auditor DIDComm transaction record by IDRemove Auditor DIDComm transaction record by IDSend 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 walletRemove data agreement CRUD DIDComm transaction record by IDCreate and store data agreement in wallet (v2)Query data agreements in the walletPublish data agreement in the walletUpdate data agreement in the wallet (v2)Delete data agreement in the walletQuery version history of a data agreementQuery data agreement personal data in walletUpdate data agreement personal data in walletDelete data agreement personal data in walletQuery data agreement instancesGenerate Data Agreement QR code payloadQuery Data Agreement QR code metadata recordsBase64 encode data agreement qr code payloadGenerate 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 agentSend read all data agreement template message to remote agent.
Data Agreement - MyData DID Operations
Fetch MyData DID registry transaction recordsFetch MyData DID registry DIDComm transaction record by IDRemove MyData DID registry DIDComm transaction record by IDSend create-did didcomm message to MyData DID registrySend read-did didcomm message to MyData DID registrySend delete-did messageFetch MyData DID remote records.Mark a connection as MyData DID registry.Fetch current connection marked as MyData DID registryUnmark current connection marked as MyData DID registryDummy 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
JSON-LD
Send JSON-LD processed-data didcomm message to the remote agent.
action-menu
Close the active menu associated with a connectionFetch the active menuPerform an action associated with the active menuRequest the active menuSend an action menu to a connection
basicmessage
Send a basic message to a connection
connection
Query agent-to-agent connectionsFetch a single connection recordRemove an existing connection recordCreate a new static connectionCreate a new connection invitationReceive a new connection invitationAccept a stored connection invitationAccept a stored connection requestAssign another connection as the inbound connectionWell-known endpoint for connectionCreate a new connection invitation (Overridden API)Generate firebase dynamic link for connection invitationSend 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 ledgerSearch for matching credential definitions that agent originatedGets a credential definition from the ledger
credentials
Fetch a credential from wallet by idRemove a credential from the wallet by idQuery credential revocation status by idGet attribute MIME types from walletFetch credentials from wallet
introduction
Start an introduction between two connections
issue-credential
Fetch all credential exchange recordsFetch a single credential exchange recordRemove an existing credential exchange recordSend holder a credential, automating entire flowSend holder a credential, automating entire flowSend issuer a credential proposalSend holder a credential offer, independent of any proposalSend holder a credential offer in reference to a proposal with previewSend issuer a credential requestSend holder a credentialStore a received credentialSend a problem report for credential exchangeSend data agreement reject message for a credential offerSend data agreement negotiation problem report messageSend data agreement termination message.
ledger
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 anyAccept the transaction author agreement
out-of-band
Create a new connection invitationCreate a new connection invitation
present-proof
Fetch all present-proof exchange recordsFetch a single presentation exchange recordRemove an existing presentation exchange recordFetch credentials for a presentation request from walletSends a presentation proposal Creates a presentation request not bound to any proposal or existing connection Sends a free presentation request not bound to any proposalSends a presentation request in reference to a proposalSends a proof presentationVerify a received presentationSend a presentation request in reference to a data agreementSend data agreement reject message for a presentation requestSend data agreement negotiation problem report messageSend data agreement termination message.
schema
Sends a schema to the ledgerSearch for matching schema that agent originatedGets a schema from the ledger
wallet
List wallet DIDsCreate a local DIDFetch the current public DIDAssign the current public DIDUpdate endpoint in wallet and on ledger if posted to itQuery DID endpoint in walletRotate keypair for a DID not posted to the ledger
Create QR code
Getting started
2.0 Define Data Agreements
Create data agreementFetch data agreementUpdate data agreementDelete data agreement
4.0 Implement APIs-4.1 Establishing connection with Cloud/Mobile wallets
Fetch connection recordCreate a new connection invitationCreate Firebase dynamic link for connection record
4.0 Implement APIs-4.2 Issue/expose data to a connection (Data Source)
Fetch credential issuance history recordIssue credential to connection
4.0 Implement APIs-4.3 Verify/consume data from a connection (Data Using Service)
Fetch verification history recordSend verification request to connectionCreate verification QR codeCreate Firebase dynamic link for verification
5.0 Enable webhooks and subscribe to events-5.1 Configure webhook URL
Endpoint
iGrant.io API documentation
audit
LIST - Fetch all organisational logsLIST - Fetch all consent recordsREAD - Get consent recordLIST - Fetch all data agreementsREAD - Get data agreement
config
CREATE - Create data agreementREAD - Read data agreementUPDATE - Update data agreementDELETE - Delete data agreementLIST - List all data agreementsLIST - List data agreement revisionsREAD - Read data attributesUPDATE - Update data attributeLIST - List all data attributesCREATE - Create data policyREAD - Read data policyUPDATE - Update data policyDELETE - Delete data policyLIST - List all data policiesLIST - List data policy revisionsCREATE - Create individualREAD - Read individualUPDATE - Update individualLIST - List all individualsCREATE - Create individual(s) via csvCREATE - Create webhookREAD - Read webhookUPDATE - Update webhookDELETE - Delete webhookLIST - List all webhooksPing webhookLIST - List all webhook deliveriesREAD - Read webhook deliveryRe-deliver a webhook eventREAD - Read webhook event typesLIST - List all webhook content typesCREATE - Create IDPREAD - Read IdP detailsUPDATE - Update IDPDELETE - Delete an IDPLIST - List all IdPsLIST - List all api keysCREATE - Create API keyUPDATE - Update API keyDELETE - Delete API key
service
READ - Read organisation cover imageREAD - Read organisation logo imageREAD - Read IdP detailsREAD - Read organisationLIST - List all active data agreementsREAD - Read data agreementLIST - List data attributesREAD - Read data policyLIST - List all data agreementsREAD - Read latest consent recordLIST - List all consent recordsCREATE - Create consent recordREAD - Read consent recordCREATE - Create draft consent recordCREATE - Create consent record and signatureLIST - List all consent records for individualDELETE - Delete all consent recordsUPDATE - Update consent recordCREATE - Creates blank signatureUPDATE - Update consent record signatureLIST - List all consent recordsLIST - List consent record historyCREATE - Create individualREAD - Read individualUPDATE - Update individualLIST - List all individualsREAD - Read organisation imageREAD - Read data sharing UI
onboard
UPDATE - Update organisation adminonboard Get AdminCREATE - Register organisation adminUPDATE - Update organisation admin avatar imageonboard Get Admin Avataronboard Reset Passwordonboard Forgot Passwordlogin Organisation Adminlogin Individuallogoutget OrganisationCREATE - Add organizationupdate Organisationget Organisation Cover Imageupdate Organisation Cover Imageget Organisation Logo Imageupdate Organisation Logo ImageREAD - Read organisation imagerefresh Tokenexchange Code For Tokenonboard Read StatusCREATE - Validate phoneCREATE - Validate emailCREATE - Verify phoneCREATE - Verify OTPREAD - Read organisation
billing
READ - Read Billing PlansREAD - Read BillingCREATE - Register BillingUPDATE - Update BillingCREATE - Add Billing AddressCREATE - Add Billing PaymentSourceCREATE - Add Billing Subscribe PlanDELETE - Cancel billing planREAD - Read Billing Subscribe PlanREAD - Read InvoicesREAD - Read Service Agreement UrlCREATE - Process billing webhook
data verifier
CREATE - Add data verifier userREAD - Read data verifier userUPDATE - Update data verifier userDELETE - Delete data verifier userLIST - List all data verifier usersCREATE - Send magic linkREAD - Redirect magic linkonboard Resolve Magic Link
organisation type
CREATE - Add organization TypeREAD - Read organization typeUPDATE - Update organisation typeDELETE - Delete organization typeLIST - List all organisation types
user request (individual)
READ - Read delete my dataCREATE - Create delete my data requestREAD - Read delete my data statusCANCEL - Cancel delete mydata user requestREAD - Read download my data requestCREATE - Create download my data requestREAD - Read download my data statusCANCEL - Cancel download mydata user requestREAD - Read update my dataCREATE - Create update my data requestREAD - Read update mydata statusCANCEL - Cancel update mydata user requestREAD - Read data request status
user request (organisation admin)
READ - Read data requestUPDATE - Update data requestsLIST - List data requests
deployment (privacy dashboard)
GET - Read privacy dashboard versionsGET - Read privacy dashboardCREATE - Deploy privacy dashboardDELETE - Delete privacy dashboardUPDATE - Update privacy dashboard versionUPDATE - Update privacy dashboard hostname
deployment (digital wallet)
GET - Read digital wallet versionsGET - Read digital walletCREATE - Deploy digital walletDELETE - Delete digital walletUPDATE - Update digital wallet versionUPDATE - Update auto respond credential proposal startup commandUPDATE - Update digital wallet webhook urlDELETE - Delete digital wallet webhook urlGET - Read digital wallet status listGET - Read ledger network with genesis transactionsGET - Read ledger network listCREATE - Enable tlsREAD - Read tls statusUPDATE - Disable tlsREAD - Read predefined self attested verificate templates
digital wallet
READ - Read Organisation IdentifierCREATE - Create Connection InvitationCREATE - Receive Connection Invitationdelete ConnectionLIST - List all connectionsCreate - Issue Credentiallist Credential Historydelete Credential HistoryCreate - Send verification requestlist Verification Historydelete Verification HistoryCREATE - Create Verification QRCREATE - Create Firebase dynamic link for verification QRconnection Webhookissue Credential Webhookverification WebhookREAD - Read Schema
HomeDigital WalletData Controller

Data Controller

Number of APIs: 1

  1. Send data controller details message to remote agent hosted by Data Controller POST {{baseUrl}}/v1/data-controller/didcomm/details/connections/:connection_id
Previous
Fetch all registered MyData DIDs
Next
Send data controller details message to remote agent hosted by Data Controller