# DataConsentsApi

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

Method HTTP request Description
downloadConsentedDocumentAnalysis GET /v1/consents/{consentId}/documents/{documentId}/analysis Get analysis of a consented document.
downloadIndividualConsentedDocumentById GET /v1/consents/individuals/{consentId}/documents/{documentId}/download Download individual consented document by document id.
downloadOrganizationConsentedDocumentById GET /v1/consents/organizations/{consentId}/documents/{documentId}/download Download organization consent document based on document id.
getAllConsentedFinancialAccounts GET /v1/consents/individuals/{consentId}/financial-accounts Get all individual consented financial accounts.
getConsentFinancialAccounts GET /v1/consents/organizations/{consentId}/financial-accounts Get all organizational consented financial accounts.
getConsentedAccountById GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId} Get individual consented financial account details based on account id.
getConsentedDocumentById GET /v1/consents/individuals/{consentId}/documents/{documentId} Get individual consented document by document id.
getConsentedFinancialAccount GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId} Get organization consented financial account details based on account id.
getConsentedFinancialAccountInsights GET /v1/consents/{consentId}/financial-accounts/{accountId}/insights Get consented financial account insights.
getConsentedFinancialAccountTransactions GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions Get individual consented financial account transactions of an individual based on accountId.
getConsents GET /v1/consents/individuals Get the paginated list of individual data consents.
getIndividualConsentedDocuments GET /v1/consents/individuals/{consentId}/documents Get individual consented documents by consent id.
getIndividualDataConsentById GET /v1/consents/individuals/{consentId} Get individuals data consent details by consent id.
getOrgConsentedAccountTransactions GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId}/transactions Get organization consented financial account transactions of an individual based on accountId.
getOrganizationConsentedDocumentById GET /v1/consents/organizations/{consentId}/documents/{documentId} Get organization consent document based on document id.
getOrganizationConsentedDocuments GET /v1/consents/organizations/{consentId}/documents Get organization consented documents by consent id.
getOrganizationDataConsentById GET /v1/consents/organizations/{consentId} Get organizations data consent details by consent id.
getOrganizationDataConsents GET /v1/consents/organizations Get the paginated list of organization data consents.

# downloadConsentedDocumentAnalysis

downloadConsentedDocumentAnalysis(consentId, documentId)

Get analysis of a consented document.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    String consentId = "consentId_example"; // String | Data consent id.
    String documentId = "documentId_example"; // String | Consented document Id.
    try {
      apiInstance.downloadConsentedDocumentAnalysis(consentId, documentId);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#downloadConsentedDocumentAnalysis");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId String Data consent id.
documentId String Consented document Id.

# Return type

null (empty response body)

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# downloadIndividualConsentedDocumentById

downloadIndividualConsentedDocumentById(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.models.*;
import com.mydatamyconsent.api.DataConsentsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Individual data consent id.
    String documentId = "documentId_example"; // String | Consented document id.
    try {
      apiInstance.downloadIndividualConsentedDocumentById(consentId, documentId);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#downloadIndividualConsentedDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Individual data consent id.
documentId String Consented document id.

# Return type

null (empty response body)

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# downloadOrganizationConsentedDocumentById

downloadOrganizationConsentedDocumentById(consentId, documentId)

Download organization consent document based on document id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Organization data consent id.
    String documentId = "documentId_example"; // String | Organization consented document Id.
    try {
      apiInstance.downloadOrganizationConsentedDocumentById(consentId, documentId);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#downloadOrganizationConsentedDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Organization data consent id.
documentId String Organization consented document Id.

# Return type

null (empty response body)

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getAllConsentedFinancialAccounts

DataConsentFinancialsDto getAllConsentedFinancialAccounts(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.models.*;
import com.mydatamyconsent.api.DataConsentsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    try {
      DataConsentFinancialsDto result = apiInstance.getAllConsentedFinancialAccounts(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getAllConsentedFinancialAccounts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Consent id.

# Return type

DataConsentFinancialsDto

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsentFinancialAccounts

DataConsentFinancialsDto getConsentFinancialAccounts(consentId)

Get all organizational consented financial accounts.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    try {
      DataConsentFinancialsDto result = apiInstance.getConsentFinancialAccounts(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentFinancialAccounts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Consent id.

# Return type

DataConsentFinancialsDto

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsentedAccountById

FinancialAccount getConsentedAccountById(consentId, accountId)

Get individual consented financial account details based on account id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    UUID accountId = UUID.randomUUID(); // UUID | Account id.
    try {
      FinancialAccount result = apiInstance.getConsentedAccountById(consentId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentedAccountById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Parameters

Name Type Description Notes
consentId UUID Consent id.
accountId UUID Account id.

# Return type

FinancialAccount

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsentedDocumentById

DataConsentDocument getConsentedDocumentById(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.models.*;
import com.mydatamyconsent.api.DataConsentsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Individual data consent id.
    String documentId = "documentId_example"; // String | Consented document id.
    try {
      DataConsentDocument result = apiInstance.getConsentedDocumentById(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentedDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Parameters

Name Type Description Notes
consentId UUID Individual data consent id.
documentId String Consented document id.

# Return type

DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getConsentedFinancialAccount

OrganizationFinancialAccountDto getConsentedFinancialAccount(consentId, accountId)

Get organization consented financial account details based on account id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    UUID accountId = UUID.randomUUID(); // UUID | Account id.
    try {
      OrganizationFinancialAccountDto result = apiInstance.getConsentedFinancialAccount(consentId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentedFinancialAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Parameters

Name Type Description Notes
consentId UUID Consent id.
accountId UUID Account id.

# Return type

OrganizationFinancialAccountDto

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsentedFinancialAccountInsights

getConsentedFinancialAccountInsights(consentId, accountId)

Get consented financial account insights.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String accountId = "accountId_example"; // String | 
    try {
      apiInstance.getConsentedFinancialAccountInsights(consentId, accountId);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentedFinancialAccountInsights");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId String
accountId String

# Return type

null (empty response body)

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsentedFinancialAccountTransactions

UserAccountFinancialTransactionsDtoPaginatedList getConsentedFinancialAccountTransactions(consentId, accountId, filters, fromDateTimeUtc, toDateTimeUtc, pageNo, pageSize)

Get individual consented financial account transactions of an individual based on accountId.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    UUID accountId = UUID.randomUUID(); // UUID | Account id.
    String filters = "filters_example"; // String | Filters.
    OffsetDateTime fromDateTimeUtc = OffsetDateTime.now(); // OffsetDateTime | From date time in utc timezone.
    OffsetDateTime toDateTimeUtc = OffsetDateTime.now(); // OffsetDateTime | Til date time in utc timezone.
    Integer pageNo = 10; // Integer | Page number.
    Integer pageSize = 25; // Integer | Number of items to return.
    try {
      UserAccountFinancialTransactionsDtoPaginatedList result = apiInstance.getConsentedFinancialAccountTransactions(consentId, accountId, filters, fromDateTimeUtc, toDateTimeUtc, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsentedFinancialAccountTransactions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Parameters

Name Type Description Notes
consentId UUID Consent id.
accountId UUID Account id.
filters String Filters. [optional]
fromDateTimeUtc OffsetDateTime From date time in utc timezone. [optional]
toDateTimeUtc OffsetDateTime Til date time in utc timezone. [optional]
pageNo Integer Page number. [optional] [default to 10]
pageSize Integer Number of items to return. [optional] [default to 25]

# Return type

UserAccountFinancialTransactionsDtoPaginatedList

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getConsents

DataConsentDetailsPaginatedList getConsents(status, fromDateTime, toDateTime, pageNo, pageSize)

Get the paginated list of individual data consents.

GetIndividualDataConsents

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    DataConsentStatus status = DataConsentStatus.fromValue("Pending"); // DataConsentStatus | Data consent status.
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | From datetime in UTC timezone.
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | To datetime in UTC timezone.
    Integer pageNo = 1; // Integer | Page number.
    Integer pageSize = 25; // Integer | Number of items to return.
    try {
      DataConsentDetailsPaginatedList result = apiInstance.getConsents(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getConsents");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# Parameters

Name Type Description Notes
status DataConsentStatus Data consent status. [optional] [enum: Pending, Approved, Rejected, Revoked, Expired, Timeout, Canceled]
fromDateTime OffsetDateTime From datetime in UTC timezone. [optional]
toDateTime OffsetDateTime To datetime in UTC timezone. [optional]
pageNo Integer Page number. [optional] [default to 1]
pageSize Integer Number of items to return. [optional] [default to 25]

# Return type

DataConsentDetailsPaginatedList

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
500 Server Error -

# getIndividualConsentedDocuments

List<DataConsentDocument> getIndividualConsentedDocuments(consentId)

Get individual consented documents by consent id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Individual data consent id.
    try {
      List<DataConsentDocument> result = apiInstance.getIndividualConsentedDocuments(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getIndividualConsentedDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Individual data consent id.

# Return type

List<DataConsentDocument>

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getIndividualDataConsentById

DataConsent getIndividualDataConsentById(consentId)

Get individuals data consent details by consent id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Individual data consent id.
    try {
      DataConsent result = apiInstance.getIndividualDataConsentById(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getIndividualDataConsentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Individual data consent id.

# Return type

DataConsent

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getOrgConsentedAccountTransactions

OrganizationFinancialTransactionsDtoPaginatedList getOrgConsentedAccountTransactions(consentId, accountId, filters, fromDateTimeUtc, toDateTimeUtc, pageNo, pageSize)

Get organization consented financial account transactions of an individual based on accountId.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Consent id.
    UUID accountId = UUID.randomUUID(); // UUID | Account id.
    String filters = "filters_example"; // String | Filters.
    OffsetDateTime fromDateTimeUtc = OffsetDateTime.now(); // OffsetDateTime | From date time in utc timezone.
    OffsetDateTime toDateTimeUtc = OffsetDateTime.now(); // OffsetDateTime | Til date time in utc timezone.
    Integer pageNo = 1; // Integer | Page number.
    Integer pageSize = 25; // Integer | Number of items to return.
    try {
      OrganizationFinancialTransactionsDtoPaginatedList result = apiInstance.getOrgConsentedAccountTransactions(consentId, accountId, filters, fromDateTimeUtc, toDateTimeUtc, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getOrgConsentedAccountTransactions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Parameters

Name Type Description Notes
consentId UUID Consent id.
accountId UUID Account id.
filters String Filters. [optional]
fromDateTimeUtc OffsetDateTime From date time in utc timezone. [optional]
toDateTimeUtc OffsetDateTime Til date time in utc timezone. [optional]
pageNo Integer Page number. [optional] [default to 1]
pageSize Integer Number of items to return. [optional] [default to 25]

# Return type

OrganizationFinancialTransactionsDtoPaginatedList

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
500 Server Error -

# getOrganizationConsentedDocumentById

DataConsentDocument getOrganizationConsentedDocumentById(consentId, documentId)

Get organization consent document based on document id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Organization data consent id.
    String documentId = "documentId_example"; // String | Organization consented document Id.
    try {
      DataConsentDocument result = apiInstance.getOrganizationConsentedDocumentById(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getOrganizationConsentedDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Parameters

Name Type Description Notes
consentId UUID Organization data consent id.
documentId String Organization consented document Id.

# Return type

DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getOrganizationConsentedDocuments

List<DataConsentDocument> getOrganizationConsentedDocuments(consentId)

Get organization consented documents by consent id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Organization data consent id.
    try {
      List<DataConsentDocument> result = apiInstance.getOrganizationConsentedDocuments(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getOrganizationConsentedDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Organization data consent id.

# Return type

List<DataConsentDocument>

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getOrganizationDataConsentById

DataConsent getOrganizationDataConsentById(consentId)

Get organizations data consent details by consent id.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    UUID consentId = UUID.randomUUID(); // UUID | Organization data consent id.
    try {
      DataConsent result = apiInstance.getOrganizationDataConsentById(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getOrganizationDataConsentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Parameters

Name Type Description Notes
consentId UUID Organization data consent id.

# Return type

DataConsent

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -

# getOrganizationDataConsents

DataConsentDetailsPaginatedList getOrganizationDataConsents(status, fromDateTime, toDateTime, pageNo, pageSize)

Get the paginated list of organization data consents.

# Example

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

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mydatamyconsent.com");

    DataConsentsApi apiInstance = new DataConsentsApi(defaultClient);
    DataConsentStatus status = DataConsentStatus.fromValue("Pending"); // DataConsentStatus | Data consent status.
    OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | From datetime in UTC timezone.
    OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | To datetime in UTC timezone.
    Integer pageNo = 1; // Integer | Page number.
    Integer pageSize = 25; // Integer | Number of items to return.
    try {
      DataConsentDetailsPaginatedList result = apiInstance.getOrganizationDataConsents(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataConsentsApi#getOrganizationDataConsents");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# Parameters

Name Type Description Notes
status DataConsentStatus Data consent status. [optional] [enum: Pending, Approved, Rejected, Revoked, Expired, Timeout, Canceled]
fromDateTime OffsetDateTime From datetime in UTC timezone. [optional]
toDateTime OffsetDateTime To datetime in UTC timezone. [optional]
pageNo Integer Page number. [optional] [default to 1]
pageSize Integer Number of items to return. [optional] [default to 25]

# Return type

DataConsentDetailsPaginatedList

# Authorization

No authorization required

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
500 Server Error -
Last Updated: 6/19/2022, 7:27:56 PM