Consents

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///consents/"
import { APIApi } from "@apiture/consents-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Consents.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///consents/apiDoc"
import { APIApi } from "@apiture/consents-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Consents.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


ConsentTypeName

getConsentTypeNames

Retrieve the set of consent type names

Return the set of reserved consent type names. The `name` property of a consent must be one of these reserved names. This list may be updated by the financial institution via the `updateConsentTypeNames` operation. The default list includes the following names: * `productTermsAndConditions` * `privacyPolicy` * `electronicConsent`


/consentTypeNames

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///consents/consentTypeNames"
import { ConsentTypeNameApi } from "@apiture/consents-client-sdk";

const consentTypeNameApi = new ConsentTypeNameApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
consentTypeNameApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
consentTypeNameApi.setApiKey(apiKey);


var api = new Consents.ConsentTypeNameApi.getConsentTypeNames()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
consentTypeNameApi.getConsentTypeNames(callback);

Scopes

banking/read Read access to consents
banking/write Write (update) access to consents
banking/full Full access to consents

Parameters

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for operations which update the resource.

updateConsentTypeNames

Replace the set of consent type names

A financial institution can use this operation to register additional types of consent that they may request from their users. The `type` property of a consent must be one of these reserved names. This operation completely replaces the set of reserved consent type names, so it should include all items from the `getConsentTypeNames` that are in use. This operation is only available to financial institution administrators.


/consentTypeNames

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///consents/consentTypeNames"
import { ConsentTypeNameApi } from "@apiture/consents-client-sdk";

const consentTypeNameApi = new ConsentTypeNameApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
consentTypeNameApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
consentTypeNameApi.setApiKey(apiKey);


var api = new Consents.ConsentTypeNameApi.updateConsentTypeNames()
var consentTypeNames = ; // {ConsentTypeNames} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
consentTypeNameApi.updateConsentTypeNames(consentTypeNames, opts, callback);

Scopes

banking/read Read access to consents
banking/write Write (update) access to consents
banking/full Full access to consents

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
consentTypeNames *

The set of consent type names

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for operations which update the resource.