Invitations

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:///invitations/"
import { APIApi } from "@apiture/invitations-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Invitations.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:///invitations/apiDoc"
import { APIApi } from "@apiture/invitations-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Invitations.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


Invitation

completeInvitation

Complete an Invitation

Complete an invitation that is eligible to be completed. Only Invitations which are `accepted` can be completed. This admin operation is invoked from the `apiture:complete` link on an Invitation, which only exists if the action is allowed. This changes the `state` to `completed`. `Completed` means the desired result (user added as joint owner or authorized signer) has been completed.


/completed

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///invitations/completed?invitation="
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.completeInvitation()
var invitation = invitation_example; // {String} A server-supplied value which identifies the invitation instance.
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);
  }
};
invitationApi.completeInvitation(invitation, opts, callback);

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

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.
Query parameters
Name Description
invitation*
String
A server-supplied value which identifies the invitation instance.
Required

Responses


createInvitation

Create a new invitation

Create a new invitation resource and send the invitation email to the invitee.


/invitations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///invitations/invitations"
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.createInvitation()
var createInvitation = ; // {CreateInvitation} 

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

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

Parameters

Body parameters
Name Description
createInvitation *

The data necessary to create a new invitation.

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 *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteInvitation

Delete this invitation resource

Delete this invitation resource and any resources that are owned by it.


/invitations/{invitationId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///invitations/invitations/{invitationId}"
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.deleteInvitation()
var invitationId = invitationId_example; // {String} The unique identifier of this invitation. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
invitationApi.deleteInvitation(invitationId, callback);

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

Parameters

Path parameters
Name Description
invitationId*
String
The unique identifier of this invitation. This is an opaque string.
Required

Responses


getInvitation

Fetch a representation of this invitation

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this invitation resource.


/invitations/{invitationId}

Usage and SDK Samples

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

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.getInvitation()
var invitationId = invitationId_example; // {String} The unique identifier of this invitation. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

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

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

Parameters

Path parameters
Name Description
invitationId*
String
The unique identifier of this invitation. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

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 *`PUT`* or *`PATCH`* operations which update this invitation resource.


getInvitations

Return a collection of invitations

Return a [paginated](http://developer.apiture.com/docs/concepts/pagination) [sortable](http://developer.apiture.com/docs/concepts/sorting) [filterable](http://developer.apiture.com/docs/concepts/filtering) [searchable](http://developer.apiture.com/docs/concepts/searching) collection of invitations. The [links](http://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/invitations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///invitations/invitations?start=&limit=&sortBy=&filter=&q=&pendingInvitations=&accountUri=&organizationUri=&state=&type=&emailAddress="
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.getInvitations()
var opts = {
  'start': 789, // {Long} The zero-based index of the first invitation item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of invitation representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](http://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](http://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](http://developer.apiture.com/docs/concepts/searching).
  'pendingInvitations': true, // {Boolean} Subset the invitations collection to those pending invitations for the currently authenticated user.  These are invitations that have been verified by the authenticated user but still require some user action to complete the invitation process. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'accountUri': accountUri_example, // {String} Subset the invitations collection to those with this `accountUri` value. Use `|` to separate multiple values. For example, `?accountUri=https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `accountUri` is `https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'organizationUri': organizationUri_example, // {String} Subset the invitations collection to those with this `organizationUri` value. Use `|` to separate multiple values. For example,` ?organizationUri=https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `organizationUri` is `https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'state': state_example, // {String} Subset the invitations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=sent` matches only items whose `state` is `sent`; `?state=sent|accepted` matches items whose `state` is `sent` or `accepted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the invitations collection to those whose `type` matches this value. Use `|` to separate multiple values. For example, `?type=joint` matches only items whose `type` is `joint`; `?state=joint|authorizedSigner` matches items whose `type` is `joint` or `authorizedSigner`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'emailAddress': emailAddress_example // {String} Subset the invitations collection to those with this `emailAddress` value. Use `|` to separate multiple values. For example, `?emailAddress=johnsmith@email.com` matches only items whose `emailAddress` is `johnsmith@email.com`; `?emailAddress=johnsmith@email.com|tomjones@email.com` will match items whose `emailAddress` is `johnsmith@email.com` or `tomjones@email.com`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

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

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first invitation item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of invitation representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](http://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](http://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](http://developer.apiture.com/docs/concepts/searching).
pendingInvitations
Boolean
Subset the invitations collection to those pending invitations for the currently authenticated user. These are invitations that have been verified by the authenticated user but still require some user action to complete the invitation process. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
accountUri
String
Subset the invitations collection to those with this `accountUri` value. Use `|` to separate multiple values. For example, `?accountUri=https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `accountUri` is `https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
organizationUri
String
Subset the invitations collection to those with this `organizationUri` value. Use `|` to separate multiple values. For example,` ?organizationUri=https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `organizationUri` is `https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
state
String
Subset the invitations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=sent` matches only items whose `state` is `sent`; `?state=sent|accepted` matches items whose `state` is `sent` or `accepted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the invitations collection to those whose `type` matches this value. Use `|` to separate multiple values. For example, `?type=joint` matches only items whose `type` is `joint`; `?state=joint|authorizedSigner` matches items whose `type` is `joint` or `authorizedSigner`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
emailAddress
String
Subset the invitations collection to those with this `emailAddress` value. Use `|` to separate multiple values. For example, `?emailAddress=johnsmith@email.com` matches only items whose `emailAddress` is `johnsmith@email.com`; `?emailAddress=johnsmith@email.com|tomjones@email.com` will match items whose `emailAddress` is `johnsmith@email.com` or `tomjones@email.com`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


revokeInvitation

Revoke an Invitation

Revoke an invitation that is eligible to be revoked. Only Invitations which are `sent` can be revoked. This operation is invoked from the `apiture:revoke` link on an Invitation, which only exists if the action is allowed. This changes the `state` to `revoked`.


/revoked

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///invitations/revoked?invitation="
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.revokeInvitation()
var invitation = invitation_example; // {String} A server-supplied value which identifies the invitation instance.
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);
  }
};
invitationApi.revokeInvitation(invitation, opts, callback);

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

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.
Query parameters
Name Description
invitation*
String
A server-supplied value which identifies the invitation instance.
Required

Responses


sendInvitation

Send an Invitation

This action will re-send an already `sent` invitation to the invitee. Only Invitations which are already `sent` can be re-sent. This operation is invoked from the `apiture:send` link on an Invitation, which only exists if the action is allowed. There is a configurable limit of times that an invitation can be re-sent.


/sent

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///invitations/sent?invitation="
import { InvitationApi } from "@apiture/invitations-client-sdk";

const invitationApi = new InvitationApi(configuration);

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

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


var api = new Invitations.InvitationApi.sendInvitation()
var invitation = invitation_example; // {String} A server-supplied value which identifies the invitation instance.
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);
  }
};
invitationApi.sendInvitation(invitation, opts, callback);

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

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.
Query parameters
Name Description
invitation*
String
A server-supplied value which identifies the invitation instance.
Required

Responses


Verification

verifyInvitation

Verify an Invitation

Verify an Invitation that is eligible to be verified. Only Invitations in a state of `sent` can be verified. `sharedSecret` and `invitationId` are required. This operation increases the `verificationCount` of the invitation identified by `invitationId`. Invitations that are `revoked` or `expired` are not processed. This operation does not verify invitations with a state of `revoked` or `expired`.


/verifications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///invitations/verifications"
import { VerificationApi } from "@apiture/invitations-client-sdk";

const verificationApi = new VerificationApi(configuration);

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

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


var api = new Invitations.VerificationApi.verifyInvitation()
var verification = ; // {Verification} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
verificationApi.verifyInvitation(verification, callback);

Scopes

banking/read Read access to invitations
banking/write Write (update) access to invitations
banking/delete Delete access to invitations
banking/full Full access to invitations

Parameters

Body parameters
Name Description
verification *

The data necessary to verify an invitation.

Responses