Organizations

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

const aPIApi = new APIApi(configuration);

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


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

const aPIApi = new APIApi(configuration);

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


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


getLabels

Localized Labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`).


/labels

Usage and SDK Samples

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

const aPIApi = new APIApi(configuration);

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


var api = new Organizations.APIApi.getLabels()
var opts = {
  'acceptLanguage': acceptLanguage_example // {String} The weighted language tags which indicate the organization's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).
};

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

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
The weighted language tags which indicate the organization's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).

Responses


Address

createAddress

Create a new address.

Add an address to the list of the organization's addresses. The new address will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`.


/organizations/{organizationId}/addresses

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/addresses?replaceId="
import { AddressApi } from "@apiture/organizations-client-sdk";

const addressApi = new AddressApi(configuration);

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

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


var api = new Organizations.AddressApi.createAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organizationAddress = ; // {OrganizationAddress} 
var opts = {
  'replaceId': replaceId_example // {String} An optional `_id` of an existing address to be _replaced_ with this new address instead of adding a new address, once it has been approved. If `replaceId` matches the `_id` of the preferred mailing address the `preferredMailingAddressId` will also be updated to the value of `replaceId` once approved. If no existing address matches `replaceId`, the new address is added to the list of addresses. Example: `?replaceId=ha1`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
organizationAddress *

The data necessary to create a new address.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing address to be _replaced_ with this new address instead of adding a new address, once it has been approved. If `replaceId` matches the `_id` of the preferred mailing address the `preferredMailingAddressId` will also be updated to the value of `replaceId` once approved. If no existing address matches `replaceId`, the new address is added to the list of addresses. Example: `?replaceId=ha1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may 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`


deleteAddress

Delete this address resource

Delete this address. The address can only be deleted if it is _not_ the organization's preferred address.


/organizations/{organizationId}/addresses/{addressId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/addresses/{addressId}"
import { AddressApi } from "@apiture/organizations-client-sdk";

const addressApi = new AddressApi(configuration);

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

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


var api = new Organizations.AddressApi.deleteAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var addressId = addressId_example; // {String} The unique identifier of this address. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
addressApi.deleteAddress(organizationId, addressId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
addressId*
String
The unique identifier of this address. This is an opaque string.
Required

Responses


getAddress

Fetch a representation of this address

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


/organizations/{organizationId}/addresses/{addressId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/addresses/{addressId}"
import { AddressApi } from "@apiture/organizations-client-sdk";

const addressApi = new AddressApi(configuration);

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

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


var api = new Organizations.AddressApi.getAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var addressId = addressId_example; // {String} The unique identifier of this address. 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);
  }
};
addressApi.getAddress(organizationId, addressId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
addressId*
String
The unique identifier of this address. 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 may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this address resource.


getAddresses

Get an organization's addresses

Return the list of the organization's addresses.


/organizations/{organizationId}/addresses

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/addresses"
import { AddressApi } from "@apiture/organizations-client-sdk";

const addressApi = new AddressApi(configuration);

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

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


var api = new Organizations.AddressApi.getAddresses()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

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

Responses


setPreferredAddress

Set Preferred mailing Address

Set the organization's preferred mailing address. The organization may set their preferred address to an _approved_ address by passing its unique `_id` in either the `value` query parameter or in the request body. This updates the `preferredAddressId` property of the organization. This operation is available via the `apiture:setAsPreferred` link on an address if that resource is eligible to be set as the preferred address. No changes are made if the specified address is already the preferred address.


/organizations/{organizationId}/preferredAddress

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/preferredAddress?value="
import { AddressApi } from "@apiture/organizations-client-sdk";

const addressApi = new AddressApi(configuration);

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

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


var api = new Organizations.AddressApi.setPreferredAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var body = body_example; // {String} 
var opts = {
  'value': value_example // {String} The `_id` of the address to assign as the preferred address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=ha1`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
body *

The `_id` of the address to assign as the preferred address, as a JSON string (the value must be quoted).

Query parameters
Name Description
value
String
The `_id` of the address to assign as the preferred address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=ha1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.


AuthorizedSigners

createAuthorizedSigner

Create a new authorized signer and associate it to an organization.

This operation will create a new authorized signer as well as associate and provide the user access to an organization. The signer must be a verified user and the user URI must be passed into _links as `apiture:user`. An authorized signer will be added through indirect operations such as a successful creation of an organization, or completion of an authorized signer invitation.


/organizations/{organizationId}/authorizedSigners

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/authorizedSigners"
import { AuthorizedSignersApi } from "@apiture/organizations-client-sdk";

const authorizedSignersApi = new AuthorizedSignersApi(configuration);

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

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


var api = new Organizations.AuthorizedSignersApi.createAuthorizedSigner()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var createAuthorizedSigner = ; // {CreateAuthorizedSigner} 

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
createAuthorizedSigner *

The authorized signer object.

Responses


getAuthorizedSigners

Fetch the organization's authorized signers

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of the array of the account's authorized signers.


/organizations/{organizationId}/authorizedSigners

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/authorizedSigners"
import { AuthorizedSignersApi } from "@apiture/organizations-client-sdk";

const authorizedSignersApi = new AuthorizedSignersApi(configuration);

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

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


var api = new Organizations.AuthorizedSignersApi.getAuthorizedSigners()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. 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);
  }
};
authorizedSignersApi.getAuthorizedSigners(organizationId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. 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 organization resource.


BeneficialOwners

getBeneficialOwners

Fetch the organization's beneficial owners

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of the array of the organization's beneficial owners. This is a list of people who own 25% or more of the company. It is tracked for regulatory purposes for all organizations which own business accounts.


/organizations/{organizationId}/beneficialOwners

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/beneficialOwners"
import { BeneficialOwnersApi } from "@apiture/organizations-client-sdk";

const beneficialOwnersApi = new BeneficialOwnersApi(configuration);

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

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


var api = new Organizations.BeneficialOwnersApi.getBeneficialOwners()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. 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);
  }
};
beneficialOwnersApi.getBeneficialOwners(organizationId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. 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 organizations resource.


updateBeneficialOwners

Update the beneficial owners of an account

Update the array of the beneficial owners. This is a list of people who own 25% or more of the company, and the percentage that they own, or who have a major role in the organization. This operation completely replaces the set of beneficial owners.


/organizations/{organizationId}/beneficialOwners

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/beneficialOwners"
import { BeneficialOwnersApi } from "@apiture/organizations-client-sdk";

const beneficialOwnersApi = new BeneficialOwnersApi(configuration);

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

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


var api = new Organizations.BeneficialOwnersApi.updateBeneficialOwners()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var beneficialOwners = ; // {BeneficialOwners} 
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);
  }
};
beneficialOwnersApi.updateBeneficialOwners(organizationId, beneficialOwners, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. 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.
Body parameters
Name Description
beneficialOwners *

The array of beneficial signers.

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 organization resource.


EmailAddress

createEmailAddress

Create a new email address

Add an email address to the list of the organization's email addresses. The new email address will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`.


/organizations/{organizationId}/emailAddresses

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/emailAddresses?replaceId="
import { EmailAddressApi } from "@apiture/organizations-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

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

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


var api = new Organizations.EmailAddressApi.createEmailAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organizationEmailAddress = ; // {OrganizationEmailAddress} 
var opts = {
  'replaceId': replaceId_example // {String} An optional `_id` of an existing email address to be _replaced_ with this new email address instead of adding a new email address, once it has been approved. If `replaceId` matches the `_id` of the preferred email address the `preferredEmailAddressId` will also be updated to the value of `replaceId` once approved. If no existing email address matches `replaceId`, the new email address is added to the list of email addresses. Example: `?replaceId=e1`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
organizationEmailAddress *

The data necessary to create a new email address.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing email address to be _replaced_ with this new email address instead of adding a new email address, once it has been approved. If `replaceId` matches the `_id` of the preferred email address the `preferredEmailAddressId` will also be updated to the value of `replaceId` once approved. If no existing email address matches `replaceId`, the new email address is added to the list of email addresses. Example: `?replaceId=e1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may 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`


deleteEmailAddress

Delete this email address resource

Delete this email address. The email address can only be deleted if it is _not_ the organization's preferred email address.


/organizations/{organizationId}/emailAddresses/{emailAddressId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}"
import { EmailAddressApi } from "@apiture/organizations-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

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

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


var api = new Organizations.EmailAddressApi.deleteEmailAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var emailAddressId = emailAddressId_example; // {String} The unique identifier of this email address. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
emailAddressApi.deleteEmailAddress(organizationId, emailAddressId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
emailAddressId*
String
The unique identifier of this email address. This is an opaque string.
Required

Responses


getEmailAddress

Fetch a representation of this email address

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


/organizations/{organizationId}/emailAddresses/{emailAddressId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}"
import { EmailAddressApi } from "@apiture/organizations-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

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

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


var api = new Organizations.EmailAddressApi.getEmailAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var emailAddressId = emailAddressId_example; // {String} The unique identifier of this email address. 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);
  }
};
emailAddressApi.getEmailAddress(organizationId, emailAddressId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
emailAddressId*
String
The unique identifier of this email address. 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 may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this email address resource.


getEmailAddresses

Get organization's email addresses

Return the list of the organization's email addresses.


/organizations/{organizationId}/emailAddresses

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/emailAddresses"
import { EmailAddressApi } from "@apiture/organizations-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

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

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


var api = new Organizations.EmailAddressApi.getEmailAddresses()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

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

Responses


setPreferredEmailAddress

Set Preferred Email Address

Set the organization's preferred email address. The organization may set their preferred email address to an _approved_ address by passing its unique `_id` in either the `value` query parameter or in the request body. This updates the `preferredEmailAddressId` property of the organization. This operation is available via the `apiture:setAsPreferred` link on an email address if that resource is eligible to be set as the preferred email address. No changes are made if the specified email address is already the preferred email address.


/organizations/{organizationId}/preferredEmailAddress

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/preferredEmailAddress?value="
import { EmailAddressApi } from "@apiture/organizations-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

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

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


var api = new Organizations.EmailAddressApi.setPreferredEmailAddress()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var body = body_example; // {String} 
var opts = {
  'value': value_example // {String} The `_id` of the email address to assign as the preferred email address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
body *

The `_id` of the email address to assign as the preferred email address, as a JSON string (the value must be quoted).

Query parameters
Name Description
value
String
The `_id` of the email address to assign as the preferred email address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.


EntityAuthorizationForm

generateEntityAuthorizationForm

Generate an entity authorization Form

Generate an entity authorization form for this organization. The form will include: * the name and role of the individual requesting the form (derived from the user making the request) * the names and roles of all existing authorized signers * the names and roles of individuals being invited to become authorized signers. If the form has not been generated for this request data, this returns 202 Accepted and no response body. The response will include a `Retry-After` response header with a recommended retry interval in seconds. If the form has been generated for this request, the operations returns 200 OK and the response body is the PDF formatted entity authorization form. Only the authorized signers associated with the owning business organization may invoke this operation.


/organizations/{organizationId}/entityAuthorizationForm

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/entityAuthorizationForm"
import { EntityAuthorizationFormApi } from "@apiture/organizations-client-sdk";

const entityAuthorizationFormApi = new EntityAuthorizationFormApi(configuration);

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

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


var api = new Organizations.EntityAuthorizationFormApi.generateEntityAuthorizationForm()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var entityAuthorizationFormRequest = ; // {EntityAuthorizationFormRequest} 
var opts = {
  'accept': accept_example // {String} Optional. Only `application/pdf` is currently supported.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
entityAuthorizationFormApi.generateEntityAuthorizationForm(organizationId, entityAuthorizationFormRequest, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Header parameters
Name Description
Accept
String
Optional. Only `application/pdf` is currently supported.
Body parameters
Name Description
entityAuthorizationFormRequest *

Responses

Name Type Format Description
ContentMinusType String When the entity authorization form is available, the response body will be the PDF formatted entity authorization form for this organization.

Name Type Format Description
RetryMinusAfter String Indicates a suggested delay in seconds after which the client should retry the operation. Example: `Retry-After: 10`


Organization

activateOrganization

Activate an organization.

Activate an organization from an inactive state. This operation is invoked from the `apiture:activate` link on an organization resource when that organization is eligible to be activated. This changes the `state` to `active`.


/activeOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/activeOrganizations?organization=&organizationUri="
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.activateOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
var opts = {
  'organizationUri': organizationUri_example, // {String} The URI of an existing organization which is eligible to be activated. This parameter is **deprecated**. Use the `?organization=` query parameter instead.
  '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);
  }
};
organizationApi.activateOrganization(organization, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

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
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
Required
organizationUri
String
The URI of an existing organization which is eligible to be activated. This parameter is **deprecated**. Use the `?organization=` query parameter instead.

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 organization resource.


createOrganization

Create a new organization

Create a new organization in the organizations collection.


/organizations

Usage and SDK Samples

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

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.createOrganization()
var createOrganization = ; // {CreateOrganization} 

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Body parameters
Name Description
createOrganization *

The data necessary to create a new organization.

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`


deactivateOrganization

Deactivate an organization.

Deactivate an organization from an active or pending state. This operation is invoked from the `apiture:deactivate` link on an organization resource when that organization is eligible to be deactivated. This changes the `state` to `inactive`.


/inactiveOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/inactiveOrganizations?organization=&organizationUri="
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.deactivateOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
var organizationUri = organizationUri_example; // {String} The URI of an existing organization which is eligible to be deactivated. This parameter is **deprecated**. Use the `?organization=` query parameter instead.
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);
  }
};
organizationApi.deactivateOrganization(organization, organizationUri, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

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
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
Required
organizationUri*
String
The URI of an existing organization which is eligible to be deactivated. This parameter is **deprecated**. Use the `?organization=` query parameter instead.
Required

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 organization resource.


deleteOrganization

Delete this organization resource

Delete this organization resource.


/organizations/{organizationId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}"
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.deleteOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
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.');
  }
};
organizationApi.deleteOrganization(organizationId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
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.

Responses


getOrganization

Fetch a representation of this organization

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


/organizations/{organizationId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}?embed="
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.getOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. 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.
  'embed':  // {array[String]} If set, the `_embedded` object in each organization in the `items` array will include additional embedded objects. This query parameter supports the `authorizedSigners` and `beneficialOwners` options. Examples:
  * `?embed=beneficialOwners`
  * `?embed=authorizedSigners,beneficialOwners`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. 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.
Query parameters
Name Description
embed
array[String]
If set, the `_embedded` object in each organization in the `items` array will include additional embedded objects. This query parameter supports the `authorizedSigners` and `beneficialOwners` options. Examples: * `?embed=beneficialOwners` * `?embed=authorizedSigners,beneficialOwners`

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 organization resource.


getOrganizations

Return a collection of organizations

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


/organizations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations?start=&limit=&sortBy=&filter=&q=&type=&state=&name=&customerId="
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.getOrganizations()
var opts = {
  'start': 789, // {Long} The zero-based index of the first organization item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of organization representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'type': type_example, // {String} Subset the organizations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=corporation` matches only items whose type is `corporation`; `?type=llp|llc` matches items whose type is `llp` or `llc`. 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 organizations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the organizations collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'customerId': customerId_example // {String} Subset the organization collection to those whose `customerId` matches this value. 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);
  }
};
organizationApi.getOrganizations(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first organization item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of organization representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
type
String
Subset the organizations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=corporation` matches only items whose type is `corporation`; `?type=llp|llc` matches items whose type is `llp` or `llc`. 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 organizations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the organizations collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
customerId
String
Subset the organization collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchOrganization

Update this organization

Perform a partial update of this organization. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/organizations/{organizationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}"
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.patchOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organization = ; // {Organization} 
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);
  }
};
organizationApi.patchOrganization(organizationId, organization, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
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
organization *

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 organization resource.


removeOrganization

Remove an organization.

Remove an organization by setting its state to `removed`. This operation is invoked from the `apiture:remove` link on a organization resource when that organization is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization). This changes the `state` to `removed`.


/removedOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/removedOrganizations?organization=&organizationUri="
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.removeOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
var organizationUri = organizationUri_example; // {String} The URI of an existing organization which is eligible to be removed. This parameter is **deprecated**. Use the `?organization=` query parameter instead.
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);
  }
};
organizationApi.removeOrganization(organization, organizationUri, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

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
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or an organization URI.
Required
organizationUri*
String
The URI of an existing organization which is eligible to be removed. This parameter is **deprecated**. Use the `?organization=` query parameter instead.
Required

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 organization resource.


updateOrganization

Update this organization

Perform a complete replacement of this organization.


/organizations/{organizationId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}"
import { OrganizationApi } from "@apiture/organizations-client-sdk";

const organizationApi = new OrganizationApi(configuration);

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

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


var api = new Organizations.OrganizationApi.updateOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organization = ; // {Organization} 
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);
  }
};
organizationApi.updateOrganization(organizationId, organization, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
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
organization *

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 organization resource.


PhoneNumber

createPhoneNumber

Create a new phone number

Add a phone number to the list of the organization's phone numbers. The new number will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`.


/organizations/{organizationId}/phoneNumbers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/phoneNumbers?replaceId="
import { PhoneNumberApi } from "@apiture/organizations-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

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

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


var api = new Organizations.PhoneNumberApi.createPhoneNumber()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organizationPhoneNumber = ; // {OrganizationPhoneNumber} 
var opts = {
  'replaceId': replaceId_example // {String} An optional `_id` of an existing phone number to be _replaced_ with this new phone number instead of adding a new phone number, once it has been approved. If `replaceId` matches the `_id` of the preferred phone number the `preferredPhoneId` will also be updated to the value of `replaceId` once approved. If no existing phone number matches `replaceId`, the new phone number is added to the list of phone numbers. Example: `?replaceId=p1`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
organizationPhoneNumber *

The data necessary to create a new phone number.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing phone number to be _replaced_ with this new phone number instead of adding a new phone number, once it has been approved. If `replaceId` matches the `_id` of the preferred phone number the `preferredPhoneId` will also be updated to the value of `replaceId` once approved. If no existing phone number matches `replaceId`, the new phone number is added to the list of phone numbers. Example: `?replaceId=p1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may 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`


deletePhoneNumber

Delete this phone number resource

Delete this phone number. The number can only be deleted if it is _not_ the organization's preferred phone number.


/organizations/{organizationId}/phoneNumbers/{phoneNumberId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}"
import { PhoneNumberApi } from "@apiture/organizations-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

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

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


var api = new Organizations.PhoneNumberApi.deletePhoneNumber()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var phoneNumberId = phoneNumberId_example; // {String} The unique identifier of this phone number. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
phoneNumberApi.deletePhoneNumber(organizationId, phoneNumberId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
phoneNumberId*
String
The unique identifier of this phone number. This is an opaque string.
Required

Responses


getPhoneNumber

Fetch a representation of this phone number

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


/organizations/{organizationId}/phoneNumbers/{phoneNumberId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}"
import { PhoneNumberApi } from "@apiture/organizations-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

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

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


var api = new Organizations.PhoneNumberApi.getPhoneNumber()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var phoneNumberId = phoneNumberId_example; // {String} The unique identifier of this phone number. 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);
  }
};
phoneNumberApi.getPhoneNumber(organizationId, phoneNumberId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
phoneNumberId*
String
The unique identifier of this phone number. 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 may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this phone number resource.


getPhoneNumbers

Get organization's phone numbers

Return the list of the organization's phone numbers


/organizations/{organizationId}/phoneNumbers

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations/{organizationId}/phoneNumbers"
import { PhoneNumberApi } from "@apiture/organizations-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

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

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


var api = new Organizations.PhoneNumberApi.getPhoneNumbers()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

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

Responses


setPreferredPhoneNumber

Set Preferred Phone Number

Set the organization's preferred phone number. The organization may set their preferred phone number to an _approved_ number by passing its unique `_id` in either the `value` query parameter or in the request body. This updates the `preferredPhoneId` property of the organization. This operation is available via the `apiture:setAsPreferred` link on an phone number if that resource is eligible to be set as the preferred phone number. No changes are made if the specified phone number is already the preferred phone number.


/organization/{organizationId}/preferredPhoneNumber

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///organizations/organization/{organizationId}/preferredPhoneNumber?value="
import { PhoneNumberApi } from "@apiture/organizations-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

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

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


var api = new Organizations.PhoneNumberApi.setPreferredPhoneNumber()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var body = body_example; // {String} 
var opts = {
  'value': value_example // {String} The `_id` of the number to assign as the preferred phone number. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`
};

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

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
body *

The `_id` of the number to assign as the preferred phone number, as a JSON string (the value must be quoted).

Query parameters
Name Description
value
String
The `_id` of the number to assign as the preferred phone number. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.