IndividualsApi

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

Method	HTTP request	Description
issuerIssuedoc1XmlPost	POST /issuer/issuedoc/1/xml	Digilocker compatible endpoint to issue document.
v1IndividualsConsentRequestsGet	GET /v1/individuals/consent-requests	Get all consent requests sent to Individuals.
v1IndividualsConsentRequestsPost	POST /v1/individuals/consent-requests	Create individual consent request.
v1IndividualsConsentRequestsRequestIdCancelPut	PUT /v1/individuals/consent-requests/{request_id}/cancel	Cancel the Individual data request by id.
v1IndividualsConsentRequestsRequestIdGet	GET /v1/individuals/consent-requests/{request_id}	Get Individual data consent request by id.
v1IndividualsConsentTemplatesGet	GET /v1/individuals/consent-templates	Get the paginated list of individual consent templates.
v1IndividualsConsentTemplatesTemplateIdGet	GET /v1/individuals/consent-templates/{template_id}	Get Individual consent template details by consent id.
v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet	GET /v1/individuals/consents/{consent_id}/documents/{document_id}/download	Download Individual consented document by document id.
v1IndividualsConsentsConsentIdDocumentsDocumentIdGet	GET /v1/individuals/consents/{consent_id}/documents/{document_id}	Get Individual consented document by document id.
v1IndividualsConsentsConsentIdDocumentsGet	GET /v1/individuals/consents/{consent_id}/documents	Get Individual consented document by consent id.
v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet	GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id}	Get individual consented financial account details.
v1IndividualsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet	GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id}/transactions	Get individual consented financial account transactions.
v1IndividualsConsentsConsentIdFinancialAccountsGet	GET /v1/individuals/consents/{consent_id}/financial-accounts	Get all individual consented financial accounts.
v1IndividualsConsentsConsentIdGet	GET /v1/individuals/consents/{consent_id}	Get Individuals consent details by consent id.
v1IndividualsConsentsConsentIdHealthFhirBundleGet	GET /v1/individuals/consents/{consent_id}/health/fhir/bundle	Get Individual consented Health Records by consent id.
v1IndividualsConsentsGet	GET /v1/individuals/consents	Get the paginated list of Individual consents.
v1IndividualsDocumentsIssueIssueRequestIdUploadPost	POST /v1/individuals/documents/issue/{issue_request_id}/upload	Upload a document for issuance request of individual.
v1IndividualsDocumentsIssuePost	POST /v1/individuals/documents/issue	Issue a new document to an individual user.
v1IndividualsDocumentsIssuedDocumentIdGet	GET /v1/individuals/documents/issued/{document_id}	Get issued document.
v1IndividualsDocumentsIssuedGet	GET /v1/individuals/documents/issued	Get paginated list of issued documents of given document type.
v1IndividualsDocumentsTypesGet	GET /v1/individuals/documents/types	Get paginated list of registered document types.

issuerIssuedoc1XmlPost

PushUriResponse issuerIssuedoc1XmlPost(pushUriRequest)

Digilocker compatible endpoint to issue document.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    PushUriRequest pushUriRequest = new PushUriRequest(); // PushUriRequest | 
    try {
      PushUriResponse result = apiInstance.issuerIssuedoc1XmlPost(pushUriRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#issuerIssuedoc1XmlPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pushUriRequest	PushUriRequest

Return type

PushUriResponse

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentRequestsGet

PaginatedListOfIndividualConsentRequestDetailss v1IndividualsConsentRequestsGet(status, fromDateTime, toDateTime, pageNo, pageSize)

Get all consent requests sent to Individuals.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    DataConsentStatus status = DataConsentStatus.fromValue("Pending"); // DataConsentStatus | 
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfIndividualConsentRequestDetailss result = apiInstance.v1IndividualsConsentRequestsGet(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentRequestsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Notes
status	DataConsentStatus	[optional] [enum: Pending, Approved, Rejected, Revoked, Expired, Timeout, Canceled]
fromDateTime	OffsetDateTime	[optional]
toDateTime	OffsetDateTime	[optional]
pageNo	Integer	[optional]
pageSize	Integer	[optional]

Return type

PaginatedListOfIndividualConsentRequestDetailss

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentRequestsPost

IndividualConsentRequestDetails v1IndividualsConsentRequestsPost(createConsentRequest)

Create individual consent request.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    CreateConsentRequest createConsentRequest = new CreateConsentRequest(); // CreateConsentRequest | 
    try {
      IndividualConsentRequestDetails result = apiInstance.v1IndividualsConsentRequestsPost(createConsentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentRequestsPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
createConsentRequest	CreateConsentRequest

Return type

IndividualConsentRequestDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentRequestsRequestIdCancelPut

Boolean v1IndividualsConsentRequestsRequestIdCancelPut(requestId)

Cancel the Individual data request by id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String requestId = "requestId_example"; // String | 
    try {
      Boolean result = apiInstance.v1IndividualsConsentRequestsRequestIdCancelPut(requestId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentRequestsRequestIdCancelPut");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
requestId	String

Return type

Boolean

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentRequestsRequestIdGet

ConsentRequest v1IndividualsConsentRequestsRequestIdGet(requestId)

Get Individual data consent request by id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String requestId = "requestId_example"; // String | 
    try {
      ConsentRequest result = apiInstance.v1IndividualsConsentRequestsRequestIdGet(requestId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentRequestsRequestIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
requestId	String

Return type

ConsentRequest

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentTemplatesGet

PaginatedListOfConsentRequestTemplates v1IndividualsConsentTemplatesGet(pageNo, pageSize)

Get the paginated list of individual consent templates.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfConsentRequestTemplates result = apiInstance.v1IndividualsConsentTemplatesGet(pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentTemplatesGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pageNo	Integer		[optional]
pageSize	Integer		[optional]

Return type

PaginatedListOfConsentRequestTemplates

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentTemplatesTemplateIdGet

IndividualConsentRequestTemplateDetails v1IndividualsConsentTemplatesTemplateIdGet(templateId)

Get Individual consent template details by consent id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String templateId = "templateId_example"; // String | 
    try {
      IndividualConsentRequestTemplateDetails result = apiInstance.v1IndividualsConsentTemplatesTemplateIdGet(templateId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentTemplatesTemplateIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
templateId	String

Return type

IndividualConsentRequestTemplateDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet

File v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet(consentId, documentId)

Download Individual consented document by document id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String documentId = "documentId_example"; // String | 
    try {
      File result = apiInstance.v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String
documentId	String

Return type

File

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		* CONTENT-DISPOSITION -
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdDocumentsDocumentIdGet

ConsentedDocument v1IndividualsConsentsConsentIdDocumentsDocumentIdGet(consentId, documentId)

Get Individual consented document by document id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String documentId = "documentId_example"; // String | 
    try {
      ConsentedDocument result = apiInstance.v1IndividualsConsentsConsentIdDocumentsDocumentIdGet(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdDocumentsDocumentIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String
documentId	String

Return type

ConsentedDocument

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdDocumentsGet

List<ConsentedDocument> v1IndividualsConsentsConsentIdDocumentsGet(consentId)

Get Individual consented document by consent id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      List<ConsentedDocument> result = apiInstance.v1IndividualsConsentsConsentIdDocumentsGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdDocumentsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String

Return type

List<ConsentedDocument>

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet

FinancialAccount v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet(consentId, accountId)

Get individual consented financial account details.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String accountId = "accountId_example"; // String | 
    try {
      FinancialAccount result = apiInstance.v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet(consentId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String
accountId	String

Return type

FinancialAccount

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet

PaginatedListOfFinancialAccountTransactions v1IndividualsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet(consentId, accountId, fromDateTime, toDateTime, pageNo, pageSize)

Get individual consented financial account transactions.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String accountId = "accountId_example"; // String | 
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfFinancialAccountTransactions result = apiInstance.v1IndividualsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet(consentId, accountId, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Notes
consentId	String
accountId	String
fromDateTime	OffsetDateTime	[optional]
toDateTime	OffsetDateTime	[optional]
pageNo	Integer	[optional]
pageSize	Integer	[optional]

Return type

PaginatedListOfFinancialAccountTransactions

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdFinancialAccountsGet

List<FinancialAccount> v1IndividualsConsentsConsentIdFinancialAccountsGet(consentId)

Get all individual consented financial accounts.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      List<FinancialAccount> result = apiInstance.v1IndividualsConsentsConsentIdFinancialAccountsGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdFinancialAccountsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String

Return type

List<FinancialAccount>

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdGet

ConsentDetails v1IndividualsConsentsConsentIdGet(consentId)

Get Individuals consent details by consent id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      ConsentDetails result = apiInstance.v1IndividualsConsentsConsentIdGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String

Return type

ConsentDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsConsentIdHealthFhirBundleGet

FhirBundleany v1IndividualsConsentsConsentIdHealthFhirBundleGet(consentId)

Get Individual consented Health Records by consent id.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      FhirBundleany result = apiInstance.v1IndividualsConsentsConsentIdHealthFhirBundleGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsConsentIdHealthFhirBundleGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
consentId	String

Return type

FhirBundleany

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsConsentsGet

PaginatedListOfConsents v1IndividualsConsentsGet(status, fromDateTime, toDateTime, pageNo, pageSize)

Get the paginated list of Individual consents.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    DataConsentStatus status = DataConsentStatus.fromValue("Pending"); // DataConsentStatus | 
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfConsents result = apiInstance.v1IndividualsConsentsGet(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsConsentsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Notes
status	DataConsentStatus	[optional] [enum: Pending, Approved, Rejected, Revoked, Expired, Timeout, Canceled]
fromDateTime	OffsetDateTime	[optional]
toDateTime	OffsetDateTime	[optional]
pageNo	Integer	[optional]
pageSize	Integer	[optional]

Return type

PaginatedListOfConsents

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsDocumentsIssueIssueRequestIdUploadPost

UploadDocumentResponse v1IndividualsDocumentsIssueIssueRequestIdUploadPost(issueRequestId, _file)

Upload a document for issuance request of individual.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String issueRequestId = "issueRequestId_example"; // String | 
    File _file = new File("/path/to/file"); // File | 
    try {
      UploadDocumentResponse result = apiInstance.v1IndividualsDocumentsIssueIssueRequestIdUploadPost(issueRequestId, _file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsDocumentsIssueIssueRequestIdUploadPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
issueRequestId	String
_file	File

Return type

UploadDocumentResponse

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsDocumentsIssuePost

DocumentIssueRequestDetails v1IndividualsDocumentsIssuePost(documentIssueRequest)

Issue a new document to an individual user.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    DocumentIssueRequest documentIssueRequest = new DocumentIssueRequest(); // DocumentIssueRequest | 
    try {
      DocumentIssueRequestDetails result = apiInstance.v1IndividualsDocumentsIssuePost(documentIssueRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsDocumentsIssuePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentIssueRequest	DocumentIssueRequest

Return type

DocumentIssueRequestDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsDocumentsIssuedDocumentIdGet

IssuedDocument v1IndividualsDocumentsIssuedDocumentIdGet(documentId)

Get issued document.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String documentId = "documentId_example"; // String | 
    try {
      IssuedDocument result = apiInstance.v1IndividualsDocumentsIssuedDocumentIdGet(documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsDocumentsIssuedDocumentIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String

Return type

IssuedDocument

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsDocumentsIssuedGet

PaginatedListOfIssuedDocuments v1IndividualsDocumentsIssuedGet(documentTypeId, fromDateTime, toDateTime, pageNo, pageSize)

Get paginated list of issued documents of given document type.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    String documentTypeId = "documentTypeId_example"; // String | 
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | 
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfIssuedDocuments result = apiInstance.v1IndividualsDocumentsIssuedGet(documentTypeId, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsDocumentsIssuedGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Notes
documentTypeId	String
fromDateTime	OffsetDateTime	[optional]
toDateTime	OffsetDateTime	[optional]
pageNo	Integer	[optional]
pageSize	Integer	[optional]

Return type

PaginatedListOfIssuedDocuments

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

v1IndividualsDocumentsTypesGet

PaginatedListOfDocumentTypes v1IndividualsDocumentsTypesGet(pageNo, pageSize)

Get paginated list of registered document types.

Example

// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.auth.*;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.IndividualsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");
    
    // Configure OAuth2 access token for authorization: OAuth2ClientCredentials
    OAuth OAuth2ClientCredentials = (OAuth) defaultClient.getAuthentication("OAuth2ClientCredentials");
    OAuth2ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

    IndividualsApi apiInstance = new IndividualsApi(defaultClient);
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfDocumentTypes result = apiInstance.v1IndividualsDocumentsTypesGet(pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IndividualsApi#v1IndividualsDocumentsTypesGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pageNo	Integer		[optional]
pageSize	Integer		[optional]

Return type

PaginatedListOfDocumentTypes

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200		-
400		-
401		-
404		-
500		-

Files

IndividualsApi.md

Latest commit

History

IndividualsApi.md

File metadata and controls

IndividualsApi

issuerIssuedoc1XmlPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentRequestsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentRequestsPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentRequestsRequestIdCancelPut

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentRequestsRequestIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentTemplatesGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentTemplatesTemplateIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentsConsentIdDocumentsDocumentIdDownloadGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentsConsentIdDocumentsDocumentIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentsConsentIdDocumentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1IndividualsConsentsConsentIdFinancialAccountsAccountIdGet

Example

Parameters