OrganizationsApi

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

Method	HTTP request	Description
v1OrganizationsConsentRequestsGet	GET /v1/organizations/consent-requests	Get all consent requests sent to Organizations.
v1OrganizationsConsentRequestsPost	POST /v1/organizations/consent-requests	Create consent request for an Organization.
v1OrganizationsConsentRequestsRequestIdCancelPut	PUT /v1/organizations/consent-requests/{request_id}/cancel	Cancel the Organization data request by id.
v1OrganizationsConsentRequestsRequestIdGet	GET /v1/organizations/consent-requests/{request_id}	Get Organization data request by id.
v1OrganizationsConsentTemplatesGet	GET /v1/organizations/consent-templates	Get the paginated list of organization consent templates.
v1OrganizationsConsentTemplatesTemplateIdGet	GET /v1/organizations/consent-templates/{template_id}	Get Organization consent template details by consent id.
v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet	GET /v1/organizations/consents/{consent_id}/documents/{document_id}/download	Download Organization consent document by document id.
v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet	GET /v1/organizations/consents/{consent_id}/documents/{document_id}	Get Organization consent document based on document id and consent id.
v1OrganizationsConsentsConsentIdDocumentsGet	GET /v1/organizations/consents/{consent_id}/documents	Get Organization consent document by consent id.
v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet	GET /v1/organizations/consents/{consent_id}/financial-accounts/{account_id}	Get organization consented financial account details.
v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet	GET /v1/organizations/consents/{consent_id}/financial-accounts/{account_id}/transactions	Get organization consented financial account transactions.
v1OrganizationsConsentsConsentIdFinancialAccountsGet	GET /v1/organizations/consents/{consent_id}/financial-accounts	Get all organization consented financial accounts.
v1OrganizationsConsentsConsentIdGet	GET /v1/organizations/consents/{consent_id}	Get Organization consent request details by consent id.
v1OrganizationsConsentsGet	GET /v1/organizations/consents	Get the paginated list of Organization consents.
v1OrganizationsDocumentsIssuePost	POST /v1/organizations/documents/issue	Issue a new document to an organization.
v1OrganizationsDocumentsIssueUploadIssueRequestIdPost	POST /v1/organizations/documents/issue/upload/{issue_request_id}	Upload a document for issuance request of Organization.
v1OrganizationsDocumentsIssuedDocumentIdGet	GET /v1/organizations/documents/issued/{document_id}	Get issued document.
v1OrganizationsDocumentsIssuedGet	GET /v1/organizations/documents/issued	Get paginated list of issued documents of given document type.
v1OrganizationsDocumentsTypesGet	GET /v1/organizations/documents/types	Get paginated list of registered document types.

v1OrganizationsConsentRequestsGet

PaginatedListOfOrganizationConsentRequestDetailss v1OrganizationsConsentRequestsGet(status, fromDateTime, toDateTime, pageNo, pageSize)

Get all consent requests sent to Organizations.

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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(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 {
      PaginatedListOfOrganizationConsentRequestDetailss result = apiInstance.v1OrganizationsConsentRequestsGet(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentRequestsGet");
      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

PaginatedListOfOrganizationConsentRequestDetailss

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		-

v1OrganizationsConsentRequestsPost

OrganizationConsentRequestDetails v1OrganizationsConsentRequestsPost(createConsentRequest)

Create consent request for an Organization.

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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    CreateConsentRequest createConsentRequest = new CreateConsentRequest(); // CreateConsentRequest | 
    try {
      OrganizationConsentRequestDetails result = apiInstance.v1OrganizationsConsentRequestsPost(createConsentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentRequestsPost");
      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

OrganizationConsentRequestDetails

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		-

v1OrganizationsConsentRequestsRequestIdCancelPut

Boolean v1OrganizationsConsentRequestsRequestIdCancelPut(requestId)

Cancel the Organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String requestId = "requestId_example"; // String | 
    try {
      Boolean result = apiInstance.v1OrganizationsConsentRequestsRequestIdCancelPut(requestId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentRequestsRequestIdCancelPut");
      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		-

v1OrganizationsConsentRequestsRequestIdGet

ConsentRequest v1OrganizationsConsentRequestsRequestIdGet(requestId)

Get Organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String requestId = "requestId_example"; // String | 
    try {
      ConsentRequest result = apiInstance.v1OrganizationsConsentRequestsRequestIdGet(requestId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentRequestsRequestIdGet");
      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		-

v1OrganizationsConsentTemplatesGet

PaginatedListOfConsentRequestTemplates v1OrganizationsConsentTemplatesGet(pageNo, pageSize)

Get the paginated list of organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfConsentRequestTemplates result = apiInstance.v1OrganizationsConsentTemplatesGet(pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentTemplatesGet");
      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		-

v1OrganizationsConsentTemplatesTemplateIdGet

OrganizationConsentRequestTemplateDetails v1OrganizationsConsentTemplatesTemplateIdGet(templateId)

Get Organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String templateId = "templateId_example"; // String | 
    try {
      OrganizationConsentRequestTemplateDetails result = apiInstance.v1OrganizationsConsentTemplatesTemplateIdGet(templateId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentTemplatesTemplateIdGet");
      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

OrganizationConsentRequestTemplateDetails

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		-

v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet

File v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet(consentId, documentId)

Download Organization consent 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String documentId = "documentId_example"; // String | 
    try {
      File result = apiInstance.v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet");
      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		-

v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet

ConsentedDocument v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet(consentId, documentId)

Get Organization consent document based on document id and 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String documentId = "documentId_example"; // String | 
    try {
      ConsentedDocument result = apiInstance.v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet(consentId, documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet");
      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		-

v1OrganizationsConsentsConsentIdDocumentsGet

List<ConsentedDocument> v1OrganizationsConsentsConsentIdDocumentsGet(consentId)

Get Organization consent 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      List<ConsentedDocument> result = apiInstance.v1OrganizationsConsentsConsentIdDocumentsGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdDocumentsGet");
      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		-

v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet

FinancialAccount v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet(consentId, accountId)

Get organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    String accountId = "accountId_example"; // String | 
    try {
      FinancialAccount result = apiInstance.v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet(consentId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet");
      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		-

v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet

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

Get organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(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.v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet(consentId, accountId, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet");
      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		-

v1OrganizationsConsentsConsentIdFinancialAccountsGet

List<FinancialAccount> v1OrganizationsConsentsConsentIdFinancialAccountsGet(consentId)

Get all organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      List<FinancialAccount> result = apiInstance.v1OrganizationsConsentsConsentIdFinancialAccountsGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdFinancialAccountsGet");
      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		-

v1OrganizationsConsentsConsentIdGet

ConsentDetails v1OrganizationsConsentsConsentIdGet(consentId)

Get Organization consent request 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String consentId = "consentId_example"; // String | 
    try {
      ConsentDetails result = apiInstance.v1OrganizationsConsentsConsentIdGet(consentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsConsentIdGet");
      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		-

v1OrganizationsConsentsGet

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

Get the paginated list of Organization 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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(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.v1OrganizationsConsentsGet(status, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsConsentsGet");
      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		-

v1OrganizationsDocumentsIssuePost

DocumentIssueRequestDetails v1OrganizationsDocumentsIssuePost(documentIssueRequest)

Issue a new document to an organization.

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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    DocumentIssueRequest documentIssueRequest = new DocumentIssueRequest(); // DocumentIssueRequest | 
    try {
      DocumentIssueRequestDetails result = apiInstance.v1OrganizationsDocumentsIssuePost(documentIssueRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsDocumentsIssuePost");
      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		-

v1OrganizationsDocumentsIssueUploadIssueRequestIdPost

UploadDocumentResponse v1OrganizationsDocumentsIssueUploadIssueRequestIdPost(issueRequestId, _file)

Upload a document for issuance request of Organization.

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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String issueRequestId = "issueRequestId_example"; // String | 
    File _file = new File("/path/to/file"); // File | 
    try {
      UploadDocumentResponse result = apiInstance.v1OrganizationsDocumentsIssueUploadIssueRequestIdPost(issueRequestId, _file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsDocumentsIssueUploadIssueRequestIdPost");
      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		-

v1OrganizationsDocumentsIssuedDocumentIdGet

IssuedDocument v1OrganizationsDocumentsIssuedDocumentIdGet(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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    String documentId = "documentId_example"; // String | 
    try {
      IssuedDocument result = apiInstance.v1OrganizationsDocumentsIssuedDocumentIdGet(documentId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsDocumentsIssuedDocumentIdGet");
      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		-

v1OrganizationsDocumentsIssuedGet

PaginatedListOfIssuedDocuments v1OrganizationsDocumentsIssuedGet(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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(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.v1OrganizationsDocumentsIssuedGet(documentTypeId, fromDateTime, toDateTime, pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsDocumentsIssuedGet");
      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		-

v1OrganizationsDocumentsTypesGet

PaginatedListOfDocumentTypes v1OrganizationsDocumentsTypesGet(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.OrganizationsApi;

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");

    OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
    Integer pageNo = 56; // Integer | 
    Integer pageSize = 56; // Integer | 
    try {
      PaginatedListOfDocumentTypes result = apiInstance.v1OrganizationsDocumentsTypesGet(pageNo, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrganizationsApi#v1OrganizationsDocumentsTypesGet");
      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		-

Uh oh!

FilesExpand file tree

OrganizationsApi.md

Latest commit

History

OrganizationsApi.md

File metadata and controls

OrganizationsApi

v1OrganizationsConsentRequestsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentRequestsPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentRequestsRequestIdCancelPut

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentRequestsRequestIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentTemplatesGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentTemplatesTemplateIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentsConsentIdDocumentsDocumentIdDownloadGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentsConsentIdDocumentsDocumentIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentsConsentIdDocumentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1OrganizationsConsentsConsentIdFinancialAccountsAccountIdTransactionsGet

Example