# \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(ctx, consentId, documentId).Execute()

Get analysis of a consented document.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "consentId_example" // string | Data consent id.
    documentId := "documentId_example" // string | Consented document Id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.DownloadConsentedDocumentAnalysis(context.Background(), consentId, documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.DownloadConsentedDocumentAnalysis``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Data consent id.
documentId string Consented document Id.

# Other Parameters

Other parameters are passed through a pointer to a apiDownloadConsentedDocumentAnalysisRequest struct via the builder pattern

Name Type Description Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# DownloadIndividualConsentedDocumentById

DownloadIndividualConsentedDocumentById(ctx, consentId, documentId).Execute()

Download individual consented document by document id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Individual data consent id.
    documentId := "documentId_example" // string | Consented document id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.DownloadIndividualConsentedDocumentById(context.Background(), consentId, documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.DownloadIndividualConsentedDocumentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Individual data consent id.
documentId string Consented document id.

# Other Parameters

Other parameters are passed through a pointer to a apiDownloadIndividualConsentedDocumentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# DownloadOrganizationConsentedDocumentById

DownloadOrganizationConsentedDocumentById(ctx, consentId, documentId).Execute()

Download organization consent document based on document id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization data consent id.
    documentId := "documentId_example" // string | Organization consented document Id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.DownloadOrganizationConsentedDocumentById(context.Background(), consentId, documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.DownloadOrganizationConsentedDocumentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Organization data consent id.
documentId string Organization consented document Id.

# Other Parameters

Other parameters are passed through a pointer to a apiDownloadOrganizationConsentedDocumentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetAllConsentedFinancialAccounts

DataConsentFinancialsDto GetAllConsentedFinancialAccounts(ctx, consentId).Execute()

Get all individual consented financial accounts.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetAllConsentedFinancialAccounts(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetAllConsentedFinancialAccounts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAllConsentedFinancialAccounts`: DataConsentFinancialsDto
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetAllConsentedFinancialAccounts`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetAllConsentedFinancialAccountsRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsentFinancialsDto

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentFinancialAccounts

DataConsentFinancialsDto GetConsentFinancialAccounts(ctx, consentId).Execute()

Get all organizational consented financial accounts.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentFinancialAccounts(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentFinancialAccounts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsentFinancialAccounts`: DataConsentFinancialsDto
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsentFinancialAccounts`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentFinancialAccountsRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsentFinancialsDto

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentedAccountById

FinancialAccount GetConsentedAccountById(ctx, consentId, accountId).Execute()

Get individual consented financial account details based on account id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.
    accountId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Account id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentedAccountById(context.Background(), consentId, accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentedAccountById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsentedAccountById`: FinancialAccount
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsentedAccountById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.
accountId string Account id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentedAccountByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

FinancialAccount

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentedDocumentById

DataConsentDocument GetConsentedDocumentById(ctx, consentId, documentId).Execute()

Get individual consented document by document id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Individual data consent id.
    documentId := "documentId_example" // string | Consented document id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentedDocumentById(context.Background(), consentId, documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentedDocumentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsentedDocumentById`: DataConsentDocument
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsentedDocumentById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Individual data consent id.
documentId string Consented document id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentedDocumentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentedFinancialAccount

OrganizationFinancialAccountDto GetConsentedFinancialAccount(ctx, consentId, accountId).Execute()

Get organization consented financial account details based on account id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.
    accountId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Account id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentedFinancialAccount(context.Background(), consentId, accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentedFinancialAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsentedFinancialAccount`: OrganizationFinancialAccountDto
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsentedFinancialAccount`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.
accountId string Account id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentedFinancialAccountRequest struct via the builder pattern

Name Type Description Notes

# Return type

OrganizationFinancialAccountDto

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentedFinancialAccountInsights

GetConsentedFinancialAccountInsights(ctx, consentId, accountId).Execute()

Get consented financial account insights.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "consentId_example" // string | 
    accountId := "accountId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentedFinancialAccountInsights(context.Background(), consentId, accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentedFinancialAccountInsights``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string
accountId string

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentedFinancialAccountInsightsRequest struct via the builder pattern

Name Type Description Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsentedFinancialAccountTransactions

UserAccountFinancialTransactionsDtoPaginatedList GetConsentedFinancialAccountTransactions(ctx, consentId, accountId).Filters(filters).FromDateTimeUtc(fromDateTimeUtc).ToDateTimeUtc(toDateTimeUtc).PageNo(pageNo).PageSize(pageSize).Execute()

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

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.
    accountId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Account id.
    filters := "filters_example" // string | Filters. (optional)
    fromDateTimeUtc := time.Now() // time.Time | From date time in utc timezone. (optional)
    toDateTimeUtc := time.Now() // time.Time | Til date time in utc timezone. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 10)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsentedFinancialAccountTransactions(context.Background(), consentId, accountId).Filters(filters).FromDateTimeUtc(fromDateTimeUtc).ToDateTimeUtc(toDateTimeUtc).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsentedFinancialAccountTransactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsentedFinancialAccountTransactions`: UserAccountFinancialTransactionsDtoPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsentedFinancialAccountTransactions`: %v\n", resp)
}
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

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.
accountId string Account id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentedFinancialAccountTransactionsRequest struct via the builder pattern

Name Type Description Notes

filters | string | Filters. | fromDateTimeUtc | time.Time | From date time in utc timezone. | toDateTimeUtc | time.Time | Til date time in utc timezone. | pageNo | int32 | Page number. | [default to 10] pageSize | int32 | Number of items to return. | [default to 25]

# Return type

UserAccountFinancialTransactionsDtoPaginatedList

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetConsents

DataConsentDetailsPaginatedList GetConsents(ctx).Status(status).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()

Get the paginated list of individual data consents.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    status := openapiclient.DataConsentStatus("Pending") // DataConsentStatus | Data consent status. (optional)
    fromDateTime := time.Now() // time.Time | From datetime in UTC timezone. (optional)
    toDateTime := time.Now() // time.Time | To datetime in UTC timezone. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetConsents(context.Background()).Status(status).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetConsents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetConsents`: DataConsentDetailsPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetConsents`: %v\n", resp)
}
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

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiGetConsentsRequest struct via the builder pattern

Name Type Description Notes
status DataConsentStatus Data consent status.
fromDateTime time.Time From datetime in UTC timezone.
toDateTime time.Time To datetime in UTC timezone.
pageNo int32 Page number. [default to 1]
pageSize int32 Number of items to return. [default to 25]

# Return type

DataConsentDetailsPaginatedList

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetIndividualConsentedDocuments

[]DataConsentDocument GetIndividualConsentedDocuments(ctx, consentId).Execute()

Get individual consented documents by consent id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Individual data consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetIndividualConsentedDocuments(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetIndividualConsentedDocuments``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIndividualConsentedDocuments`: []DataConsentDocument
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetIndividualConsentedDocuments`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Individual data consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetIndividualConsentedDocumentsRequest struct via the builder pattern

Name Type Description Notes

# Return type

[]DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetIndividualDataConsentById

DataConsent GetIndividualDataConsentById(ctx, consentId).Execute()

Get individuals data consent details by consent id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Individual data consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetIndividualDataConsentById(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetIndividualDataConsentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIndividualDataConsentById`: DataConsent
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetIndividualDataConsentById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Individual data consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetIndividualDataConsentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsent

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetOrgConsentedAccountTransactions

OrganizationFinancialTransactionsDtoPaginatedList GetOrgConsentedAccountTransactions(ctx, consentId, accountId).Filters(filters).FromDateTimeUtc(fromDateTimeUtc).ToDateTimeUtc(toDateTimeUtc).PageNo(pageNo).PageSize(pageSize).Execute()

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

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Consent id.
    accountId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Account id.
    filters := "filters_example" // string | Filters. (optional)
    fromDateTimeUtc := time.Now() // time.Time | From date time in utc timezone. (optional)
    toDateTimeUtc := time.Now() // time.Time | Til date time in utc timezone. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetOrgConsentedAccountTransactions(context.Background(), consentId, accountId).Filters(filters).FromDateTimeUtc(fromDateTimeUtc).ToDateTimeUtc(toDateTimeUtc).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetOrgConsentedAccountTransactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrgConsentedAccountTransactions`: OrganizationFinancialTransactionsDtoPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetOrgConsentedAccountTransactions`: %v\n", resp)
}
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

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Consent id.
accountId string Account id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetOrgConsentedAccountTransactionsRequest struct via the builder pattern

Name Type Description Notes

filters | string | Filters. | fromDateTimeUtc | time.Time | From date time in utc timezone. | toDateTimeUtc | time.Time | Til date time in utc timezone. | pageNo | int32 | Page number. | [default to 1] pageSize | int32 | Number of items to return. | [default to 25]

# Return type

OrganizationFinancialTransactionsDtoPaginatedList

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetOrganizationConsentedDocumentById

DataConsentDocument GetOrganizationConsentedDocumentById(ctx, consentId, documentId).Execute()

Get organization consent document based on document id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization data consent id.
    documentId := "documentId_example" // string | Organization consented document Id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetOrganizationConsentedDocumentById(context.Background(), consentId, documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetOrganizationConsentedDocumentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationConsentedDocumentById`: DataConsentDocument
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetOrganizationConsentedDocumentById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Organization data consent id.
documentId string Organization consented document Id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationConsentedDocumentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetOrganizationConsentedDocuments

[]DataConsentDocument GetOrganizationConsentedDocuments(ctx, consentId).Execute()

Get organization consented documents by consent id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization data consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetOrganizationConsentedDocuments(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetOrganizationConsentedDocuments``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationConsentedDocuments`: []DataConsentDocument
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetOrganizationConsentedDocuments`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Organization data consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationConsentedDocumentsRequest struct via the builder pattern

Name Type Description Notes

# Return type

[]DataConsentDocument

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetOrganizationDataConsentById

DataConsent GetOrganizationDataConsentById(ctx, consentId).Execute()

Get organizations data consent details by consent id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    consentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization data consent id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetOrganizationDataConsentById(context.Background(), consentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetOrganizationDataConsentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationDataConsentById`: DataConsent
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetOrganizationDataConsentById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
consentId string Organization data consent id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationDataConsentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

DataConsent

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetOrganizationDataConsents

DataConsentDetailsPaginatedList GetOrganizationDataConsents(ctx).Status(status).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()

Get the paginated list of organization data consents.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    status := openapiclient.DataConsentStatus("Pending") // DataConsentStatus | Data consent status. (optional)
    fromDateTime := time.Now() // time.Time | From datetime in UTC timezone. (optional)
    toDateTime := time.Now() // time.Time | To datetime in UTC timezone. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataConsentsApi.GetOrganizationDataConsents(context.Background()).Status(status).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataConsentsApi.GetOrganizationDataConsents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationDataConsents`: DataConsentDetailsPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DataConsentsApi.GetOrganizationDataConsents`: %v\n", resp)
}
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

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationDataConsentsRequest struct via the builder pattern

Name Type Description Notes
status DataConsentStatus Data consent status.
fromDateTime time.Time From datetime in UTC timezone.
toDateTime time.Time To datetime in UTC timezone.
pageNo int32 Page number. [default to 1]
pageSize int32 Number of items to return. [default to 25]

# Return type

DataConsentDetailsPaginatedList

# Authorization

No authorization required

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last Updated: 6/19/2022, 7:27:56 PM