My Data My Consent - Developer Documentation

# mydatamyconsent

MyDataMyConsent - the Ruby gem for the My Data My Consent - Developer API

Unleashing the power of data consent by establishing trust. The Platform Core Developer API defines a set of capabilities that can be used to request, issue, manage and update data, documents and credentials by organizations. The API can be used to request, manage and update Decentralised Identifiers, Financial Data, Health Data issue Documents, Credentials directly or using OpenID Connect flows, and verify Messages signed with DIDs and much more.

This SDK is automatically generated by the OpenAPI Generator (opens new window) project:

# Installation

# Build a gem

To build the Ruby code into a gem:

gem build mydatamyconsent.gemspec
1

Then either install the gem locally:

gem install ./mydatamyconsent-0.0.1.gem
1

(for development, run gem install --dev ./mydatamyconsent-0.0.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems (opens new window).

Finally add this to the Gemfile:

gem 'mydatamyconsent', '~> 0.0.1'

# Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/mydatamyconsent/ruby-sdk, then add the following in the Gemfile:

gem 'mydatamyconsent', :git => 'https://github.com/mydatamyconsent/ruby-sdk.git'

# Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb
1

# Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'mydatamyconsent'

api_instance = MyDataMyConsent::DataConsentRequestsApi.new
request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Individual consent request id.

begin
  #Cancel the individual data consent request by Id.
  api_instance.cancel_individual_data_consent_request(request_id)
rescue MyDataMyConsent::ApiError => e
  puts "Exception when calling DataConsentRequestsApi->cancel_individual_data_consent_request: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13

# Documentation for API Endpoints

All URIs are relative to https://api.mydatamyconsent.com

Class Method HTTP request Description
MyDataMyConsent::DataConsentRequestsApi cancel_individual_data_consent_request PUT /v1/consent-requests/individual/{requestId}/cancel Cancel the individual data consent request by Id.
MyDataMyConsent::DataConsentRequestsApi cancel_organization_data_consent_request PUT /v1/consent-requests/organization/{requestId}/cancel Cancel the organization data consent request by Id.
MyDataMyConsent::DataConsentRequestsApi create_individual_data_consent_request POST /v1/consent-requests/individual Create data consent request for an individual.
MyDataMyConsent::DataConsentRequestsApi create_organization_data_consent_request POST /v1/consent-requests/organization Create data consent request for an organization.
MyDataMyConsent::DataConsentRequestsApi get_all_consent_requests_to_individuals GET /v1/consent-requests/individuals Get all Consent Requests sent to individuals.
MyDataMyConsent::DataConsentRequestsApi get_all_consent_requests_to_organizations GET /v1/consent-requests/organizations Get all Consent Requests sent to organizations.
MyDataMyConsent::DataConsentRequestsApi get_individual_consent_request_by_id GET /v1/consent-requests/individuals/{requestId} Get individual data consent request by id.
MyDataMyConsent::DataConsentRequestsApi get_organization_consent_request_by_id GET /v1/consent-requests/organizations/{requestId} Get a OrganizationConsent Request by Id.
MyDataMyConsent::DataConsentsApi download_consented_document_analysis GET /v1/consents/{consentId}/documents/{documentId}/analysis Get analysis of a consented document.
MyDataMyConsent::DataConsentsApi download_individual_consented_document_by_id GET /v1/consents/individuals/{consentId}/documents/{documentId}/download Download individual consented document by document id.
MyDataMyConsent::DataConsentsApi download_organization_consented_document_by_id GET /v1/consents/organizations/{consentId}/documents/{documentId}/download Download organization consent document based on document id.
MyDataMyConsent::DataConsentsApi get_all_consented_financial_accounts GET /v1/consents/individuals/{consentId}/financial-accounts Get all individual consented financial accounts.
MyDataMyConsent::DataConsentsApi get_consent_financial_accounts GET /v1/consents/organizations/{consentId}/financial-accounts Get all organizational consented financial accounts.
MyDataMyConsent::DataConsentsApi get_consented_account_by_id GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId} Get individual consented financial account details based on account id.
MyDataMyConsent::DataConsentsApi get_consented_document_by_id GET /v1/consents/individuals/{consentId}/documents/{documentId} Get individual consented document by document id.
MyDataMyConsent::DataConsentsApi get_consented_financial_account GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId} Get organization consented financial account details based on account id.
MyDataMyConsent::DataConsentsApi get_consented_financial_account_insights GET /v1/consents/{consentId}/financial-accounts/{accountId}/insights Get consented financial account insights.
MyDataMyConsent::DataConsentsApi get_consented_financial_account_transactions GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions Get individual consented financial account transactions of an individual based on accountId.
MyDataMyConsent::DataConsentsApi get_consents GET /v1/consents/individuals Get the paginated list of individual data consents.
MyDataMyConsent::DataConsentsApi get_individual_consented_documents GET /v1/consents/individuals/{consentId}/documents Get individual consented documents by consent id.
MyDataMyConsent::DataConsentsApi get_individual_data_consent_by_id GET /v1/consents/individuals/{consentId} Get individuals data consent details by consent id.
MyDataMyConsent::DataConsentsApi get_org_consented_account_transactions GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId}/transactions Get organization consented financial account transactions of an individual based on accountId.
MyDataMyConsent::DataConsentsApi get_organization_consented_document_by_id GET /v1/consents/organizations/{consentId}/documents/{documentId} Get organization consent document based on document id.
MyDataMyConsent::DataConsentsApi get_organization_consented_documents GET /v1/consents/organizations/{consentId}/documents Get organization consented documents by consent id.
MyDataMyConsent::DataConsentsApi get_organization_data_consent_by_id GET /v1/consents/organizations/{consentId} Get organizations data consent details by consent id.
MyDataMyConsent::DataConsentsApi get_organization_data_consents GET /v1/consents/organizations Get the paginated list of organization data consents.
MyDataMyConsent::DataProcessingAgreementsApi create_data_processing_agreement POST /v1/data-agreements Create a data processing agreement.
MyDataMyConsent::DataProcessingAgreementsApi delete_data_processing_agreement_by_id DELETE /v1/data-agreements/{id} Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
MyDataMyConsent::DataProcessingAgreementsApi get_data_processing_agreement_by_id GET /v1/data-agreements/{id} Get data processing agreement by id.
MyDataMyConsent::DataProcessingAgreementsApi get_data_processing_agreements GET /v1/data-agreements Get paginated data processing agreements.
MyDataMyConsent::DataProcessingAgreementsApi terminate_data_processing_agreement_by_id PUT /v1/data-agreements/{id}/terminate Terminate a data processing agreement.
MyDataMyConsent::DataProcessingAgreementsApi update_data_processing_agreement PUT /v1/data-agreements/{id} Update a data processing agreement.
MyDataMyConsent::DataProviderDiscoveryApi get_data_provider_by_id GET /v1/data-providers/{providerId} Get a Data Provider details by provider id.
MyDataMyConsent::DataProviderDiscoveryApi get_data_providers GET /v1/data-providers Discover all data providers in My Data My Consent by country and filters.
MyDataMyConsent::DigiLockerCompatIssuerApi digilocker_compat_issue_document POST /issuer/issuedoc/1/xml Digilocker Compatible endpoint to issue document.
MyDataMyConsent::DocumentsApi get_issued_document_by_id GET /v1/documents/issued/{documentId} Get issued document.
MyDataMyConsent::DocumentsApi get_issued_documents GET /v1/documents/issued Get paginated list of issued documents of given document type.
MyDataMyConsent::DocumentsApi get_registered_document_types GET /v1/documents/types Get paginated list of registered document types.
MyDataMyConsent::DocumentsApi issue_document_to_individual POST /v1/documents/issue/individual Issue a new document to an individual user.
MyDataMyConsent::DocumentsApi issue_document_to_organization POST /v1/documents/issue/organization Issue a new document to an organization.
MyDataMyConsent::DocumentsApi upload_document_for_individual POST /v1/documents/issue/individual/upload/{issueRequestId} Upload a document for issuance request of individual.
MyDataMyConsent::DocumentsApi upload_document_for_organization POST /v1/documents/issue/organization/upload/{issueRequestId} Upload a document for issuance request of organization.
MyDataMyConsent::SupportedIdentifiersApi get_all_supported_identifiers GET /v1/supported-identifiers/{countryIso2Code} Get all supported identifiers by country.

# Documentation for Models

# Documentation for Authorization

# oauth2

  • Type: OAuth
  • Flow: application
  • Authorization URL: https://accounts.mydatamyconsent.com/connect/authorize
  • Scopes:
    • developer: Developer API
Last Updated: 6/19/2022, 7:27:56 PM